planetj.dataengine.application.magic
Class AbstractOperationRequest

java.lang.Object
  |
  +--planetj.html.AbstractHTMLRenderer
        |
        +--planetj.magic.AbstractMagicRequest
              |
              +--planetj.magic.MagicRequest
                    |
                    +--planetj.dataengine.application.magic.AbstractOperationRequest
All Implemented Interfaces:
IFeature, IHTMLRenderer, IMagicRequest, IRenderer, 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 class planetj.html.AbstractHTMLRenderer
className
 
Fields inherited from interface planetj.magic.IMagicRequest
IS_COMPLETE, MAGIC_REQUEST, MAGIC_REQUEST_PARAM1, MAGIC_REQUEST_RC, SAME_URI, TYPE, TYPE_PAGE, TYPE_SESSION, TYPE_STATIC, 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
 
Constructor Summary
AbstractOperationRequest(String id, Operation operation, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          AbstractOperationRequest constructor comment.
 
Method Summary
 IMagicRequest execute(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, DataEngineServlet servlet)
          Execute method comment.
abstract  AbstractOperationRequest executeOperation(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, DataEngineServlet servlet)
           
 Operation getOperation()
          Get the operation for this request.
 boolean isStartNewNavigationGroup()
          Tests whether or not this magic request needs to start a new navigation group.
 void setNextURIs(Operation operation, javax.servlet.http.HttpServletRequest request)
           
 
Methods inherited from class planetj.magic.MagicRequest
getType, store
 
Methods inherited from class planetj.magic.AbstractMagicRequest
addLinkedRequestAfter, addLinkedRequestBefore, appendUnsupportedHTMLMessage, clone, clone, equals, executeAll, getAnchorName, getBaseField, getBaseRow, getBaseRowCollection, getCurrentURI, getDefaultEndNavigationGroup, getFailMessage, getFeatureLevel, getFirstRequest, getId, getKey, getLastRequest, getMagicServletURI, getMagicURI, getNextURI, getRequestAttribute, getRequestParameter, getRequestParameterValues, getSessionAttribute, getSharedSessionAttribute, getSuccessMessage, hasLinkedRequestsAfter, hasLinkedRequestsBefore, isApplicable, isCompleted, isEndNavigationGroup, isPopup, isReturnToRequester, isSaveResults, preexecute, removeRequestAttribute, removeSessionAttribute, removeSharedSessionAttribute, setAnchorName, setBaseField, setBaseRow, setBaseRowCollection, setCompleted, setEndNavigationGroup, setFailMessage, setId, setNextURI, setNextURI, setNextURIs, setPopup, setRequestGroupAttribute, setRequestPageAttribute, setRequestPersistentAttribute, setRequestTransientAttribute, setReturnToRequester, setRowEventListener, setSessionAttribute, setSessionSharedAttribute, setStartNewNavigationGroup, setSuccessMessage
 
Methods inherited from class planetj.html.AbstractHTMLRenderer
append, generate, getDisplayType
 
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, getMagicURI, getNextURI, isCompleted, isEndNavigationGroup, isReturnToRequester, isSaveResults, setBaseField, setBaseRow, setRowEventListener
 
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
 

Constructor Detail

AbstractOperationRequest

public AbstractOperationRequest(String id,
                                Operation operation,
                                javax.servlet.http.HttpServletRequest request,
                                javax.servlet.http.HttpServletResponse response)
AbstractOperationRequest constructor comment.

Parameters:
request - javax.servlet.http.HttpServletRequest
response - javax.servlet.http.HttpServletResponse
Method Detail

execute

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

Specified by:
execute in interface IMagicRequest
Specified by:
execute in class AbstractMagicRequest
CMException

executeOperation

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

getOperation

public Operation getOperation()
                       throws CMException
Get the operation for this request.

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,
                        javax.servlet.http.HttpServletRequest request)