planetj.magic
Class MagicRequest

java.lang.Object
  |
  +--planetj.html.AbstractHTMLRenderer
        |
        +--planetj.magic.AbstractMagicRequest
              |
              +--planetj.magic.MagicRequest
All Implemented Interfaces:
IFeature, IHTMLRenderer, IMagicRequest, IRenderer, Serializable
Direct Known Subclasses:
AbstractOperationRequest, AbstractParameterRequest, AbstractRowRequest, AbstractSelectionRequest, AbstractSQLParameterRequest, AddRowRequest, CancelRequest, ChangeSystemRequest, CopyRCToTableRequest, CopyResultsRequest, CSVRequest, DeleteRequest, DeleteRowCollectionRequest, DeserializeRCRequest, DirectOperationRequest, EditFDRequest, EmailExecutionRequest, EmailRCAsCSVRequest, HTMLReferenceR, InsertRequest, MicrosoftWordRequest, MSAccessRequest, NavigateToRequest, NextOrPreviousRowRequest, PageRequest, PDFRequest, ReconcileRCRequest, RefreshPageRequest, RefreshRequest, RemoveRequest, RowCollectionRequest, RowRequest, RunSQLRequest, SaveSQLToSQLOperationRequest, 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 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
MagicRequest()
          MagicRequest constructor comment.
MagicRequest(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          MagicRequest constructor comment.
MagicRequest(String pId, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
          MagicRequest constructor comment.
 
Method Summary
 String getType()
          Get the type of magic request.
 IMagicRequest store(javax.servlet.http.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, clone, clone, equals, execute, 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, isStartNewNavigationGroup, 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, execute, executeAll, getBaseField, getBaseRow, getCurrentURI, getFirstRequest, getId, getKey, getLastRequest, getMagicURI, getNextURI, isCompleted, isEndNavigationGroup, isReturnToRequester, isSaveResults, isStartNewNavigationGroup, 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

MagicRequest

public MagicRequest()
MagicRequest constructor comment.


MagicRequest

public MagicRequest(String pId,
                    javax.servlet.http.HttpServletRequest request,
                    javax.servlet.http.HttpServletResponse response)
MagicRequest constructor comment.

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

MagicRequest

public MagicRequest(javax.servlet.http.HttpServletRequest request,
                    javax.servlet.http.HttpServletResponse response)
MagicRequest constructor comment.

Method Detail

getType

public String getType()
Get the type of magic request.

Specified by:
getType in interface IMagicRequest
Specified by:
getType in class AbstractMagicRequest

store

public IMagicRequest store(javax.servlet.http.HttpServletRequest pRequest)
Store this MagicRequest in the user's session to the DataEngineServlet can get at it when requested

Overrides:
store in class AbstractMagicRequest