planetj.dataengine.application.magic
Class DirectOperationRequest

java.lang.Object
  extended byplanetj.magic.AbstractMagicRequest
      extended byplanetj.magic.MagicRequest
          extended byplanetj.dataengine.application.magic.DirectOperationRequest
All Implemented Interfaces:
IFeature, IMagicRequest, java.io.Serializable

public class DirectOperationRequest
extends MagicRequest

Contains information identifying a SQLOperation

See Also:
Serialized Form

Nested Class Summary
 
Nested classes inherited from class planetj.dataengine.IFeature
IFeature.OperationCountFeature
 
Field Summary
static java.lang.String SESSION_ID
           
 
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
DirectOperationRequest(HttpServletRequest req, HttpServletResponse res)
          MagicRequest constructor comment.
 
Method Summary
 IMagicRequest execute(HttpServletRequest req, HttpServletResponse res, DataEngineServlet deservlet)
          Execute method comment.
static DirectOperationRequest getDirectOperationRequest(HttpServletRequest req, HttpServletResponse res)
          Gets a DirectOperationRequest if appropriate.
 java.lang.String getDisplayMode()
          Gets the mode in which the Operation should be displayed
 java.lang.String getExecutionMode()
          Gets if the operation should be immediately executed
 java.lang.String getMetadataAlias()
          Gets the alias of the system on which the Operation resides
 Operation getOperation()
          Gets the Operation in question
 int getOperationId()
          Gets the ID of the requested Operation
 boolean processOutputClass(Operation op, HttpServletRequest req, HttpServletResponse res)
          Process output class parameter.
 
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, getPleaseWaitOperation, getRequestAttribute, getRequestParameter, getRequestParameterValues, getSessionAttribute, getSharedSessionAttribute, getSuccessMessage, hasLinkedRequestsAfter, hasLinkedRequestsBefore, isApplicable, isCompleted, isEndNavigationGroup, isLoadParameterValuesFromRequest, isOverridePrimaryNavigation, isPleaseWait, isPopup, isRepeatable, isReturnToRequester, isSaveResults, isStartNewNavigationGroup, 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, isStartNewNavigationGroup, postExecute, preExecute, setBaseField, setBaseRow, setBaseRowCollection, setEndNavigationGroup, setNextURI, setOverridePrimaryNavigation, setRepeatable, setRowEventListener, setStartNewNavigationGroup
 
Methods inherited from interface planetj.dataengine.IFeature
appendUnsupportedHTMLMessage, getFeatureLevel, isApplicable
 

Field Detail

SESSION_ID

public static final java.lang.String SESSION_ID
Constructor Detail

DirectOperationRequest

public DirectOperationRequest(HttpServletRequest req,
                              HttpServletResponse res)
MagicRequest constructor comment.

Method Detail

execute

public IMagicRequest execute(HttpServletRequest req,
                             HttpServletResponse res,
                             DataEngineServlet deservlet)
                      throws CMException
Description copied from class: AbstractMagicRequest
Execute method comment.

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

getDirectOperationRequest

public static DirectOperationRequest getDirectOperationRequest(HttpServletRequest req,
                                                               HttpServletResponse res)
Gets a DirectOperationRequest if appropriate. First the parameters in the request are examined to see if the user has requested to directly execute an operation. Then the session is checked to see if a DirectOperationRequest has been created earlier and stored. If neither of these cases are true, then null is returned.


getDisplayMode

public final java.lang.String getDisplayMode()
Gets the mode in which the Operation should be displayed


getExecutionMode

public java.lang.String getExecutionMode()
Gets if the operation should be immediately executed


getMetadataAlias

public final java.lang.String getMetadataAlias()
Gets the alias of the system on which the Operation resides


getOperation

public Operation getOperation()
                       throws CMException
Gets the Operation in question

Throws:
CMException

getOperationId

public final int getOperationId()
Gets the ID of the requested Operation


processOutputClass

public boolean processOutputClass(Operation op,
                                  HttpServletRequest req,
                                  HttpServletResponse res)
                           throws CMException
Process output class parameter.

Throws:
CMException