planetj.magic
Class ViewRowRequest

java.lang.Object
  |
  +--planetj.html.AbstractHTMLRenderer
        |
        +--planetj.magic.AbstractMagicRequest
              |
              +--planetj.magic.MagicRequest
                    |
                    +--planetj.magic.RowRequest
                          |
                          +--planetj.magic.ViewRowRequest

All Implemented Interfaces:

IFeature, IHTMLRenderer, IMagicRequest, IRenderer, 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 String

KEY_DEFAULT

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

ViewRowRequest(String pId, javax.servlet.http.HttpServletRequest pRequest, javax.servlet.http.HttpServletResponse pResponse, String pURI, String pRowCollectionSessionId, String pRowSessionId)
EditRowRequest constructor comment.

Method Summary

IMagicRequest	execute(javax.servlet.http.HttpServletRequest pRequest, javax.servlet.http.HttpServletResponse pResponse, DataEngineServlet pServlet) Execute method comment.
Row	extractRow(javax.servlet.http.HttpServletRequest pRequest)
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(javax.servlet.http.HttpServletRequest pRequest)
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

getRow, getRowCollection, getRowCollectionSessionId, getRowSessionId, setRowCollectionSessionId, setRowSessionId

Methods inherited from class planetj.magic.MagicRequest

getType, store

Methods inherited from class planetj.magic.AbstractMagicRequest

addLinkedRequestAfter, addLinkedRequestBefore, appendUnsupportedHTMLMessage, clone, clone, equals, 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, 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, executeAll, getBaseField, getBaseRow, getCurrentURI, getFirstRequest, getId, getKey, getLastRequest, getMagicURI, getNextURI, isCompleted, isEndNavigationGroup, isReturnToRequester, isSaveResults, 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

Field Detail

KEY_DEFAULT

public static final String KEY_DEFAULT

See Also:

Constant Field Values

Constructor Detail

ViewRowRequest

public ViewRowRequest(String pId,
                      javax.servlet.http.HttpServletRequest pRequest,
                      javax.servlet.http.HttpServletResponse pResponse,
                      String pURI,
                      String pRowCollectionSessionId,
                      String pRowSessionId)

EditRowRequest constructor comment.

Parameters:

pId - java.lang.String

pRequest - javax.servlet.http.HttpServletRequest

pResponse - javax.servlet.http.HttpServletResponse

pURI - java.lang.String

Method Detail

execute

public IMagicRequest execute(javax.servlet.http.HttpServletRequest pRequest,
                             javax.servlet.http.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

CMException

extractRow

public Row extractRow(javax.servlet.http.HttpServletRequest pRequest)
               throws CMException

Overrides:

extractRow in class RowRequest

CMException

isRetrieveAllFieldsOnView

public boolean isRetrieveAllFieldsOnView(javax.servlet.http.HttpServletRequest pRequest)
                                  throws DataEngineException

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.