planetj.dataengine.application.magic
Class AbstractOperationRequest

java.lang.Object
  planetj.magic.AbstractMagicRequest
      planetj.magic.MagicRequest
          planetj.dataengine.application.magic.AbstractOperationRequest

All Implemented Interfaces:

IFeature, IMagicRequest, java.io.Serializable

Direct Known Subclasses:

PossibleValuesSearchOperationRequest, RunJavaOperationRequest, ViewExecutionGroupRequest, ViewHTMLOperationRequest, ViewSQLOperationRequest

public abstract class AbstractOperationRequest

extends MagicRequest

Author:

PlanetJ Corporation

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class planetj.dataengine.IFeature

IFeature.OperationCountFeature

Field Summary

Fields inherited from interface planetj.magic.IMagicRequest

IS_COMPLETE, MAGIC_REQUEST, MAGIC_REQUEST_CLASS, MAGIC_REQUEST_PARAM1, MAGIC_REQUEST_RC, SAME_URI, TYPE, TYPE_PAGE, TYPE_SESSION, TYPE_STATIC, USER_REQUEST_ATTRIBUTES_STORED

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

Constructor Summary

AbstractOperationRequest(Operation operation, HttpServletRequest request, HttpServletResponse response)
AbstractOperationRequest constructor comment.

AbstractOperationRequest(java.lang.String id, Operation operation, HttpServletRequest request, HttpServletResponse response)
Deprecated. id is no longer needed. Use AbstractOperationRequest(op, request, response)

Method Summary

IMagicRequest	execute(HttpServletRequest request, HttpServletResponse response, DataEngineServlet servlet) Execute method comment.
abstract AbstractOperationRequest	executeOperation(HttpServletRequest request, HttpServletResponse response, DataEngineServlet servlet)
Operation	getOperation() Get the operation for this request.
Operation	getPleaseWaitOperation(ExecutingContext ec) Gets the Operation used to control the please wait functionality for this MR.
boolean	isPleaseWait(ExecutingContext ec) Tests if this magic request is a please wait magic request.
boolean	isStartNewNavigationGroup() Tests whether or not this magic request needs to start a new navigation group.
void	setNextURIs(Operation operation, HttpServletRequest request)

Methods inherited from class planetj.magic.MagicRequest

getCurrentMagicRequest, getPrimaryMagicRequest, getType, store

Methods inherited from class planetj.magic.AbstractMagicRequest

addLinkedRequestAfter, addLinkedRequestBefore, appendUnsupportedHTMLMessage, changeMode, clone, clone, equals, executeAll, getAnchorName, getBaseField, getBaseRow, getBaseRowCollection, getCurrentURI, getDefaultEndNavigationGroup, getDefaultPageType, getFailMessage, getFeatureLevel, getFirstRequest, getId, getKey, getLastRequest, getMagicRequestParameter, getMagicServletURI, getMagicURI, getNextURI, getPleaseWaitJSP, getRequestAttribute, getRequestParameter, getRequestParameterValues, getSessionAttribute, getSharedSessionAttribute, getSuccessMessage, hasLinkedRequestsAfter, hasLinkedRequestsBefore, isApplicable, isCompleted, isEndNavigationGroup, isLoadParameterValuesFromRequest, isOverridePrimaryNavigation, isPopup, isRepeatable, isReturnToRequester, isSaveResults, postexecute, postExecute, preexecute, preExecute, processPleaseWait, removeRequestAttribute, removeSessionAttribute, removeSharedSessionAttribute, setAnchorName, setBaseField, setBaseRow, setBaseRowCollection, setCompleted, setEndNavigationGroup, setFailMessage, setId, setLoadParameterValuesFromRequest, setNextURI, setNextURI, setNextURI, setNextURIs, setOverridePrimaryNavigation, setPopup, setRepeatable, setRequestGroupAttribute, setRequestPageAttribute, setRequestPersistentAttribute, setRequestTransientAttribute, setReturnToRequester, setRowEventListener, setSessionAttribute, setSessionSharedAttribute, setStartNewNavigationGroup, setSuccessMessage

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface planetj.magic.IMagicRequest

addLinkedRequestAfter, addLinkedRequestBefore, executeAll, getBaseField, getBaseRow, getCurrentURI, getFirstRequest, getId, getKey, getLastRequest, getMagicRequestParameter, getMagicURI, getNextURI, isCompleted, isEndNavigationGroup, isOverridePrimaryNavigation, isRepeatable, isReturnToRequester, isSaveResults, postExecute, preExecute, setBaseField, setBaseRow, setBaseRowCollection, setEndNavigationGroup, setNextURI, setOverridePrimaryNavigation, setRepeatable, setRowEventListener, setStartNewNavigationGroup

Methods inherited from interface planetj.dataengine.IFeature

appendUnsupportedHTMLMessage, getFeatureLevel, isApplicable

Constructor Detail

AbstractOperationRequest

public AbstractOperationRequest(java.lang.String id,
                                Operation operation,
                                HttpServletRequest request,
                                HttpServletResponse response)

Deprecated. id is no longer needed. Use AbstractOperationRequest(op, request, response)

AbstractOperationRequest constructor comment.

Parameters:

request - javax.servlet.http.HttpServletRequest

response - javax.servlet.http.HttpServletResponse

AbstractOperationRequest

public AbstractOperationRequest(Operation operation,
                                HttpServletRequest request,
                                HttpServletResponse response)

AbstractOperationRequest constructor comment.

Parameters:

request - javax.servlet.http.HttpServletRequest

response - javax.servlet.http.HttpServletResponse

Method Detail

execute

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

Execute method comment.

Specified by:

execute in interface IMagicRequest

Specified by:

execute in class AbstractMagicRequest

Throws:

CMException

executeOperation

public abstract AbstractOperationRequest executeOperation(HttpServletRequest request,
                                                          HttpServletResponse response,
                                                          DataEngineServlet servlet)
                                                   throws CMException

Throws:

CMException

getPleaseWaitOperation

public Operation getPleaseWaitOperation(ExecutingContext ec)
                                 throws CMException

Gets the Operation used to control the please wait functionality for this MR. (Null may be returned, in which case this MR will not use the please wait functionality)

Overrides:

getPleaseWaitOperation in class AbstractMagicRequest

Throws:

CMException

getOperation

public Operation getOperation()
                       throws CMException

Get the operation for this request.

Throws:

CMException

isPleaseWait

public boolean isPleaseWait(ExecutingContext ec)
                     throws CMException

Tests if this magic request is a please wait magic request. When this is true, an itermediate "please wait" page is shown prior to showing the results page, instead of going directly to the results page.

Overrides:

isPleaseWait in class AbstractMagicRequest

Throws:

CMException

isStartNewNavigationGroup

public boolean isStartNewNavigationGroup()

Description copied from interface: IMagicRequest

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

Specified by:

isStartNewNavigationGroup in interface IMagicRequest

Overrides:

isStartNewNavigationGroup in class AbstractMagicRequest

setNextURIs

public void setNextURIs(Operation operation,
                        HttpServletRequest request)