planetj.magic
Interface IMagicRequest

All Superinterfaces:

IFeature, IHTMLRenderer, IRenderer

All Known Subinterfaces:

IAssociationRequest

All Known Implementing Classes:

AbstractMagicRequest, AbstractParameterRequest, AbstractSQLParameterRequest, MagicRequest

public interface IMagicRequest

extends IHTMLRenderer, IFeature

Interface for PlanetJ Magic Request. A magic request is a Servlet call that can be serviced/handled automatically (magically) by the PlanetJ DataEngineServlet with no programmer code. Examples are column sorting, refresh data. Creation date: (12/6/2001 8:22:24 PM)

Nested Class Summary

Nested classes inherited from class planetj.dataengine.IFeature

IFeature.OperationCountFeature

Field Summary

static String	IS_COMPLETE
static String	MAGIC_REQUEST
static String	MAGIC_REQUEST_PARAM1
static String	MAGIC_REQUEST_RC
static String	SAME_URI
static String	TYPE
static String	TYPE_PAGE
static String	TYPE_SESSION
static String	TYPE_STATIC
static String	USER_REQUEST_ATTRIBUTES_STORED

Fields inherited from interface planetj.html.IHTMLRenderer

HTML

Fields inherited from interface planetj.dataengine.IFeature

DEFAULT_MESSAGE_FEATURE, FEATURE_DELETE, FEATURE_INSERT, FEATURE_LEVEL_ENTERPRISE, FEATURE_LEVEL_ENTRY, FEATURE_LEVEL_PROFESSIONAL, FEATURE_LEVEL_STANDARD, FEATURE_UPDATE, MESSAGE_END, MESSAGE_START

Method Summary

void	addLinkedRequestAfter(IMagicRequest pMagicRequest) Adds the given MagicRequest to the list of requests to be executed after this MagicRequest
void	addLinkedRequestBefore(IMagicRequest pMagicRequest) Adds the given MagicRequest to the list of requests to be executed before this MagicRequest
IMagicRequest	execute(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, DataEngineServlet servlet)
IMagicRequest	executeAll(javax.servlet.http.HttpServletRequest pRequest, javax.servlet.http.HttpServletResponse pResponse, DataEngineServlet pServlet)
Field	getBaseField() Return the Base Field of this Request.
Row	getBaseRow() Get the based on Row for this Request.
String	getCurrentURI() Get the URI of the page the MagicRequest was created from.
IMagicRequest	getFirstRequest() Gets the first magic request that will be executed when executeAll() is invoked on this magic request.
String	getId() Return the id used to store this magic request in the session.
String	getKey() Return the id used to store this magic request in the session.
IMagicRequest	getLastRequest() Gets the last magic request that will be executed when executeAll() is invoked on this magic request.
String	getMagicURI() Get the URI to use to call the Magic Servlet for this request
String	getNextURI(LayoutDisplayPropertyGroup layout) Get the URI of the page to call after executing the request.
String	getType() Get the type of magic request.
boolean	isCompleted(javax.servlet.http.HttpServletRequest req) Returns whether or not the magic request needs to be returned to the requester.
boolean	isEndNavigationGroup() Tests whether or not this magic request needs to end the current navigation group and go back to the previous state of the last page of the last group.
boolean	isReturnToRequester() Returns whether or not the magic request needs to be returned to the requester.
boolean	isSaveResults() Deprecated. - from code prior to navigation and layouts - wasn't referenced or used any where !!N WK (4/22/2003 8:27:47 AM)
boolean	isStartNewNavigationGroup() Tests whether or not this magic request needs to start a new navigation group.
void	setBaseField(Field field) Set the based on Row for this Request.
void	setBaseRow(Row row) Set the based on Row for this Request.
void	setRowEventListener(IRowEventListener pListener) Sets the RowEventListener on this MagicReqest.

Methods inherited from interface planetj.html.IHTMLRenderer

append, generate

Methods inherited from interface planetj.dataengine.display.IRenderer

getDisplayType

Methods inherited from interface planetj.dataengine.IFeature

appendUnsupportedHTMLMessage, getFeatureLevel, isApplicable

Field Detail

MAGIC_REQUEST

public static final String MAGIC_REQUEST

See Also:

Constant Field Values

MAGIC_REQUEST_RC

public static final String MAGIC_REQUEST_RC

See Also:

Constant Field Values

MAGIC_REQUEST_PARAM1

public static final String MAGIC_REQUEST_PARAM1

See Also:

Constant Field Values

USER_REQUEST_ATTRIBUTES_STORED

public static final String USER_REQUEST_ATTRIBUTES_STORED

See Also:

Constant Field Values

IS_COMPLETE

public static final String IS_COMPLETE

See Also:

Constant Field Values

SAME_URI

public static final String SAME_URI

See Also:

Constant Field Values

TYPE

public static final String TYPE

See Also:

Constant Field Values

TYPE_PAGE

public static final String TYPE_PAGE

See Also:

Constant Field Values

TYPE_SESSION

public static final String TYPE_SESSION

See Also:

Constant Field Values

TYPE_STATIC

public static final String TYPE_STATIC

See Also:

Constant Field Values

Method Detail

addLinkedRequestAfter

public void addLinkedRequestAfter(IMagicRequest pMagicRequest)

Adds the given MagicRequest to the list of requests to be executed after this MagicRequest

addLinkedRequestBefore

public void addLinkedRequestBefore(IMagicRequest pMagicRequest)

Adds the given MagicRequest to the list of requests to be executed before this MagicRequest

execute

public IMagicRequest execute(javax.servlet.http.HttpServletRequest request,
                             javax.servlet.http.HttpServletResponse response,
                             DataEngineServlet servlet)
                      throws CMException

CMException

executeAll

public IMagicRequest executeAll(javax.servlet.http.HttpServletRequest pRequest,
                                javax.servlet.http.HttpServletResponse pResponse,
                                DataEngineServlet pServlet)
                         throws CMException

CMException

getBaseField

public Field getBaseField()

Return the Base Field of this Request.

getBaseRow

public Row getBaseRow()

Get the based on Row for this Request. Used when you have associations.

getCurrentURI

public String getCurrentURI()

Get the URI of the page the MagicRequest was created from.

getFirstRequest

public IMagicRequest getFirstRequest()

Gets the first magic request that will be executed when executeAll() is invoked on this magic request. If there are no requests before this one, then this same object will be returned

getId

public String getId()

Return the id used to store this magic request in the session.

getKey

public String getKey()

Return the id used to store this magic request in the session.

getLastRequest

public IMagicRequest getLastRequest()

Gets the last magic request that will be executed when executeAll() is invoked on this magic request. If there are no requests after this one, then this same object will be returned

getMagicURI

public String getMagicURI()

Get the URI to use to call the Magic Servlet for this request

getNextURI

public String getNextURI(LayoutDisplayPropertyGroup layout)

Get the URI of the page to call after executing the request. If this is equal to SAME_URI the current URI will be used. If this is null, the magic request will go back to the previous state after executing

getType

public String getType()

Get the type of magic request.

isCompleted

public boolean isCompleted(javax.servlet.http.HttpServletRequest req)

Returns whether or not the magic request needs to be returned to the requester.

isEndNavigationGroup

public boolean isEndNavigationGroup()

Tests whether or not this magic request needs to end the current navigation group and go back to the previous state of the last page of the last group.

isReturnToRequester

public boolean isReturnToRequester()

Returns whether or not the magic request needs to be returned to the requester.

isSaveResults

public boolean isSaveResults()

Deprecated. - from code prior to navigation and layouts - wasn't referenced or used any where !!N WK (4/22/2003 8:27:47 AM)

Tests if the results of executing this magic request should be saved. This allows the user to go back to this result after viewing another page. If this method returns false, and the user goes back from viewing a later page, the results of this request will be "skipped" and the user will see results from a page "before" this one.

isStartNewNavigationGroup

public boolean isStartNewNavigationGroup()

Tests whether or not this magic request needs to start a new navigation group.

setBaseField

public void setBaseField(Field field)

Set the based on Row for this Request. Used when you have associations.

setBaseRow

public void setBaseRow(Row row)

Set the based on Row for this Request. Used when you have associations.

setRowEventListener

public void setRowEventListener(IRowEventListener pListener)

Sets the RowEventListener on this MagicReqest. Creation date: (7/11/2002 11:18:06 AM)