planetj.magic
Class ViewRowRequest

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

All Implemented Interfaces:

IFeature, IMagicRequest, java.io.Serializable

public class ViewRowRequest

extends RowRequest

Author:

PlanetJ Corporation

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class planetj.dataengine.IFeature

IFeature.OperationCountFeature

Field Summary

static java.lang.String

KEY_DEFAULT

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

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

ViewRowRequest(java.lang.String pId, HttpServletRequest pRequest, HttpServletResponse pResponse, java.lang.String pURI, java.lang.String pRowCollectionSessionId, java.lang.String pRowSessionId, Row row)
Deprecated. - pass in Row object... use ViewRowRequest(String, HttpServletRequest, HttpServletResponse, String, String, String, Row)

Method Summary

IMagicRequest	execute(HttpServletRequest pRequest, HttpServletResponse pResponse, DataEngineServlet pServlet) Execute method comment.
boolean	isNextPreviousAllowed() Tests if rows edited via this request may have next & previous buttons for going to other rows in the edited row's row collection.
boolean	isRetrieveAllFieldsOnView(HttpServletRequest pRequest) Deprecated. method is no longer used for determining what fields are to be shown on edit, insert, or any details for that matter. DisplayColumns property group, the RowCollection and the Row are now used.
boolean	isStartNewNavigationGroup() Tests whether or not this magic request needs to start a new navigation group.
void	setNextPreviousAllowed(boolean np) Sets if rows edited via this request may have next & previous buttons for going to other rows in the edited row's row collection.

Methods inherited from class planetj.magic.RowRequest

extractRow, getDefaultPageType, getRow, getRowCollection, getRowCollectionSessionId, getRowSessionId, setRowCollectionSessionId, setRowSessionId

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, 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, 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, postExecute, preExecute, setBaseField, setBaseRow, setBaseRowCollection, setEndNavigationGroup, setNextURI, setOverridePrimaryNavigation, setRepeatable, setRowEventListener, setStartNewNavigationGroup

Methods inherited from interface planetj.dataengine.IFeature

appendUnsupportedHTMLMessage, getFeatureLevel, isApplicable

Field Detail

KEY_DEFAULT

public static final java.lang.String KEY_DEFAULT

See Also:

Constant Field Values

Constructor Detail

ViewRowRequest

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

Deprecated. - pass in Row object... use ViewRowRequest(String, HttpServletRequest, HttpServletResponse, String, String, String, Row)

ViewRowRequest

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

Method Detail

execute

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

Description copied from class: AbstractMagicRequest

Execute method comment.

Specified by:

execute in interface IMagicRequest

Specified by:

execute in class AbstractMagicRequest

Throws:

CMException

isRetrieveAllFieldsOnView

public boolean isRetrieveAllFieldsOnView(HttpServletRequest pRequest)
                                  throws DataEngineException

Deprecated. method is no longer used for determining what fields are to be shown on edit, insert, or any details for that matter. DisplayColumns property group, the RowCollection and the Row are now used.

Throws:

DataEngineException

isStartNewNavigationGroup

public boolean isStartNewNavigationGroup()

Description copied from interface: IMagicRequest

Tests whether or not this magic request needs to start a new navigation group.

Specified by:

isStartNewNavigationGroup in interface IMagicRequest

Overrides:

isStartNewNavigationGroup in class AbstractMagicRequest

isNextPreviousAllowed

public boolean isNextPreviousAllowed()

Tests if rows edited via this request may have next & previous buttons for going to other rows in the edited row's row collection. The default is true. Example: DisplayDetails{nextAndPrevious:false;}

setNextPreviousAllowed

public void setNextPreviousAllowed(boolean np)

Sets if rows edited via this request may have next & previous buttons for going to other rows in the edited row's row collection. The default is true.