planetj.magic
Class RowRequest

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

All Implemented Interfaces:

IFeature, IMagicRequest, java.io.Serializable

Direct Known Subclasses:

CopyRowRequest, EditRowRequest, InsertAndNewRowRequest, MagicRowSelectorRequest, PrintRowRequest, ViewRowRequest

public abstract class RowRequest

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 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

RowRequest(Row row, HttpServletRequest request, HttpServletResponse response)
Create a new row request for the given Row

RowRequest(Row row, RowCollection rc, HttpServletRequest request, HttpServletResponse response)
Create a new row request for the given Row

RowRequest(Row row, RowCollection rc, java.lang.String uri, HttpServletRequest request, HttpServletResponse response)
Create a new row request for the given Row

RowRequest(Row row, java.lang.String uri, HttpServletRequest request, HttpServletResponse response)
Create a new row request for the given Row

RowRequest(Row row, java.lang.String rowNavKey, java.lang.String uri, HttpServletRequest request, HttpServletResponse response)
Create a new row request for the given Row

RowRequest(java.lang.String pId, HttpServletRequest pRequest, HttpServletResponse pResponse, java.lang.String pURI, java.lang.String pRowCollectionSessionId, java.lang.String pRowSessionId)
Deprecated. - should pass the Row and RowCollection instead of their session ids use RowRequest(Row, RowCollection, String, HttpServletRequest, HttpServletResponse)

RowRequest(java.lang.String pId, HttpServletRequest pRequest, HttpServletResponse pResponse, java.lang.String pURI, java.lang.String pRowCollectionSessionId, java.lang.String pRowSessionId, Row pRow)
Deprecated. - changed ordering of parameters to keep consistent with all other magic request... in addition id is no longer needed and neither is the rowcollection session id since we have reference to the row itself use RowRequest(Row, String, String, HttpServletRequest, HttpServletResponse)

Method Summary

Row	extractRow(HttpServletRequest request)
PageType	getDefaultPageType(java.lang.String section) Get the PageType to use for the specified section when no PageType is explictly specified
Row	getRow(HttpServletRequest request)
RowCollection	getRowCollection(HttpServletRequest request)
java.lang.String	getRowCollectionSessionId()
java.lang.String	getRowSessionId()
void	setRowCollectionSessionId(java.lang.String pRowCollectionSessionId)
void	setRowSessionId(java.lang.String pRowSessionId)

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, execute, executeAll, getAnchorName, getBaseField, getBaseRow, getBaseRowCollection, getCurrentURI, getDefaultEndNavigationGroup, 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

RowRequest

public RowRequest(Row row,
                  HttpServletRequest request,
                  HttpServletResponse response)

Create a new row request for the given Row

RowRequest

public RowRequest(Row row,
                  RowCollection rc,
                  HttpServletRequest request,
                  HttpServletResponse response)

Create a new row request for the given Row

RowRequest

public RowRequest(Row row,
                  RowCollection rc,
                  java.lang.String uri,
                  HttpServletRequest request,
                  HttpServletResponse response)

Create a new row request for the given Row

RowRequest

public RowRequest(Row row,
                  java.lang.String uri,
                  HttpServletRequest request,
                  HttpServletResponse response)

Create a new row request for the given Row

RowRequest

public RowRequest(Row row,
                  java.lang.String rowNavKey,
                  java.lang.String uri,
                  HttpServletRequest request,
                  HttpServletResponse response)

Create a new row request for the given Row

RowRequest

public RowRequest(java.lang.String pId,
                  HttpServletRequest pRequest,
                  HttpServletResponse pResponse,
                  java.lang.String pURI,
                  java.lang.String pRowCollectionSessionId,
                  java.lang.String pRowSessionId)

Deprecated. - should pass the Row and RowCollection instead of their session ids use RowRequest(Row, RowCollection, String, HttpServletRequest, HttpServletResponse)

EditRowRequest constructor comment.

Parameters:

pId - java.lang.String

pRequest - javax.servlet.http.HttpServletRequest

pResponse - javax.servlet.http.HttpServletResponse

pURI - java.lang.String

RowRequest

public RowRequest(java.lang.String pId,
                  HttpServletRequest pRequest,
                  HttpServletResponse pResponse,
                  java.lang.String pURI,
                  java.lang.String pRowCollectionSessionId,
                  java.lang.String pRowSessionId,
                  Row pRow)

Deprecated. - changed ordering of parameters to keep consistent with all other magic request... in addition id is no longer needed and neither is the rowcollection session id since we have reference to the row itself use RowRequest(Row, String, String, HttpServletRequest, HttpServletResponse)

Method Detail

extractRow

public Row extractRow(HttpServletRequest request)
               throws CMException

Throws:

CMException

getDefaultPageType

public PageType getDefaultPageType(java.lang.String section)

Get the PageType to use for the specified section when no PageType is explictly specified

Overrides:

getDefaultPageType in class AbstractMagicRequest

getRow

public Row getRow(HttpServletRequest request)
           throws DataEngineException

Throws:

DataEngineException

getRowCollection

public RowCollection getRowCollection(HttpServletRequest request)
                               throws DataEngineException

Throws:

DataEngineException

getRowCollectionSessionId

public java.lang.String getRowCollectionSessionId()

getRowSessionId

public java.lang.String getRowSessionId()

setRowSessionId

public void setRowSessionId(java.lang.String pRowSessionId)

setRowCollectionSessionId

public void setRowCollectionSessionId(java.lang.String pRowCollectionSessionId)