planetj.magic
Class SignOffRequest

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

All Implemented Interfaces:

java.lang.Cloneable, IFeature, IMagicRequest, java.io.Serializable

Direct Known Subclasses:

ApplicationSignOffRequest, DXSignOffRequest

public class SignOffRequest

extends NavigateToRequest

implements java.lang.Cloneable

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

SignOffRequest(java.lang.String uri, HttpServletRequest request, HttpServletResponse response)
SignOffRequest constructor.

SignOffRequest(java.lang.String pId, HttpServletRequest pRequest, HttpServletResponse pResponse, java.lang.String pURI)
Deprecated. - id is no longer needed, use SignOffRequest(String, HttpServletRequest, HttpServletResponse)

Method Summary

IMagicRequest	execute(HttpServletRequest request, HttpServletResponse pResponse, DataEngineServlet pServlet) execute method comment.
int	getFeatureLevel() Gets the minimum feature level requried to execute this operation
boolean	isRepeatable() Is this request repeatable.
boolean	isSaveResults() Deprecated. - from code prior to navigation and layouts - wasn't referenced or used any where !!N WK (4/22/2003 8:27:47 AM)

Methods inherited from class planetj.magic.NavigateToRequest

setNextURI

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, 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, isReturnToRequester, isStartNewNavigationGroup, postexecute, postExecute, preexecute, preExecute, processPleaseWait, removeRequestAttribute, removeSessionAttribute, removeSharedSessionAttribute, setAnchorName, setBaseField, setBaseRow, setBaseRowCollection, setCompleted, setEndNavigationGroup, setFailMessage, setId, setLoadParameterValuesFromRequest, 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, isReturnToRequester, isStartNewNavigationGroup, postExecute, preExecute, setBaseField, setBaseRow, setBaseRowCollection, setEndNavigationGroup, setNextURI, setOverridePrimaryNavigation, setRepeatable, setRowEventListener, setStartNewNavigationGroup

Methods inherited from interface planetj.dataengine.IFeature

appendUnsupportedHTMLMessage, isApplicable

Constructor Detail

SignOffRequest

public SignOffRequest(java.lang.String uri,
                      HttpServletRequest request,
                      HttpServletResponse response)

SignOffRequest constructor.

SignOffRequest

public SignOffRequest(java.lang.String pId,
                      HttpServletRequest pRequest,
                      HttpServletResponse pResponse,
                      java.lang.String pURI)

Deprecated. - id is no longer needed, use SignOffRequest(String, HttpServletRequest, HttpServletResponse)

SignOffRequest constructor.

Parameters:

pRequest - HttpServletRequest

pResponse - HttpServletResponse

Method Detail

execute

public IMagicRequest execute(HttpServletRequest request,
                             HttpServletResponse pResponse,
                             DataEngineServlet pServlet)
                      throws CMException

execute method comment.

Specified by:

execute in interface IMagicRequest

Overrides:

execute in class NavigateToRequest

Returns:

this

Throws:

CMException

isSaveResults

public boolean isSaveResults()

Deprecated. - from code prior to navigation and layouts - wasn't referenced or used any where !!N WK (4/22/2003 8:27:47 AM)

Tests if the results of executing this magic request should be saved. This allows the user to go back to this result after viewing another page. If this method returns false, and the user goes back from viewing a later page, the results of this request will be "skipped" and the user will see results from a page "before" this one.

Specified by:

isSaveResults in interface IMagicRequest

Overrides:

isSaveResults in class AbstractMagicRequest

getFeatureLevel

public int getFeatureLevel()

Gets the minimum feature level requried to execute this operation

Specified by:

getFeatureLevel in interface IFeature

Overrides:

getFeatureLevel in class AbstractMagicRequest

isRepeatable

public boolean isRepeatable()

Is this request repeatable. For instance we don't want to repeat inserts, but it is ok to repeat refreshes Creation date: (6/10/2003 12:15:05 PM)

Specified by:

isRepeatable in interface IMagicRequest

Overrides:

isRepeatable in class AbstractMagicRequest