planetj.magic
Class MagicRequest

java.lang.Object
  planetj.magic.AbstractMagicRequest
      planetj.magic.MagicRequest

All Implemented Interfaces:

IFeature, IMagicRequest, java.io.Serializable

Direct Known Subclasses:

AbstractOperationRequest, AbstractParameterRequest, AbstractRowRequest, AbstractSelectionRequest, AbstractSQLParameterRequest, AddRowRequest, AddToFileRequest, As400RerunOperationRequest, CancelRequest, ChangeCurrentThemeRequest, ChangeSystemRequest, ClearCache, CopyRCToTableRequest, CopyResultsRequest, CreateDemoApplicationRequest, CSVRequest, DeleteRequest, DeleteRowCollectionRequest, DeserializeRCRequest, DirectOperationRequest, EditFDRequest, EmailExecutionRequest, EmailRCAsCSVRequest, HTMLReferenceR, InsertRequest, MicrosoftWordRequest, MSAccessRequest, NavigateToRequest, NextOrPreviousRowRequest, NextRowCollectionRequest, PDFRequest, PreviousRowCollectionRequest, ReconcileRCRequest, RefreshPageRequest, RefreshRequest, RemoveRequest, RowCollectionRequest, RowRequest, RunSQLRequest, SaveSQLToSQLOperationRequest, SerializeObjectRequest, SerializeRCRequest, SignOnRequest, SignOnRequest, SortRequest, SQLRequest, SystemRequest, UpdateRequest, UpdateUserSettings, ViewFDsRequest, WABDispatcherRequest, XLSRequest, XMLRequest

public abstract class MagicRequest

extends AbstractMagicRequest

implements IMagicRequest

Abstract Class for all MagicRequests

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

MagicRequest()
MagicRequest constructor comment.

MagicRequest(HttpServletRequest request, HttpServletResponse response)
MagicRequest constructor comment.

MagicRequest(java.lang.String pId, HttpServletRequest request, HttpServletResponse response)
MagicRequest constructor comment.

Method Summary

static IMagicRequest	getCurrentMagicRequest(HttpServletRequest req) Gets the magic request which is currently executing.
static IMagicRequest	getPrimaryMagicRequest(HttpServletRequest req) Gets the primary magic request.
java.lang.String	getType() Get the type of magic request.
IMagicRequest	store(HttpServletRequest pRequest) Store this MagicRequest in the user's session to the DataEngineServlet can get at it when requested

Methods inherited from class planetj.magic.AbstractMagicRequest

addLinkedRequestAfter, addLinkedRequestBefore, appendUnsupportedHTMLMessage, changeMode, clone, clone, equals, execute, 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, execute, 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

Constructor Detail

MagicRequest

public MagicRequest()

MagicRequest constructor comment.

MagicRequest

public MagicRequest(java.lang.String pId,
                    HttpServletRequest request,
                    HttpServletResponse response)

MagicRequest constructor comment.

Parameters:

pId - id of MagicRequest used to store the request in the session

MagicRequest

public MagicRequest(HttpServletRequest request,
                    HttpServletResponse response)

MagicRequest constructor comment.

Method Detail

getCurrentMagicRequest

public static IMagicRequest getCurrentMagicRequest(HttpServletRequest req)

Gets the magic request which is currently executing. This may be null if there is no such magic request

getPrimaryMagicRequest

public static IMagicRequest getPrimaryMagicRequest(HttpServletRequest req)

Gets the primary magic request. This is the magic request which has control of the navigation - all other running magic requests are linked before or after to the primary magic request. If there is not a currently running magic request this method will return null;

getType

public java.lang.String getType()

Get the type of magic request.

Specified by:

getType in interface IMagicRequest

Specified by:

getType in class AbstractMagicRequest

store

public IMagicRequest store(HttpServletRequest pRequest)

Store this MagicRequest in the user's session to the DataEngineServlet can get at it when requested

Overrides:

store in class AbstractMagicRequest