planetj.magic
Class PageRequest

java.lang.Object
  planetj.magic.AbstractMagicRequest
      planetj.magic.MagicRequest
          planetj.magic.RowCollectionRequest
              planetj.magic.PageRequest

All Implemented Interfaces:

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

public class PageRequest

extends RowCollectionRequest

implements java.lang.Cloneable

Request a different page of the RC Creation date: (12/6/2001 8:37:51 PM)

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class planetj.dataengine.IFeature

IFeature.OperationCountFeature

Field Summary

static short	PAGE_FIRST
static short	PAGE_LAST
static short	PAGE_NEXT
static short	PAGE_PREVIOUS
static java.lang.String	REQUEST_ID

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

PageRequest(RowCollection rc, HttpServletRequest request, HttpServletResponse response)
Create a new PageRequest for the given RC

Method Summary

static java.lang.StringBuffer	appendText(RowCollection rc, HTMLTable table, boolean useText, java.lang.StringBuffer html, HttpServletRequest req) Appends text for the first, previous, next, or last link on an HTMLTable
static java.lang.StringBuffer	appendText(java.lang.String rcKey, short type, boolean link, java.lang.StringBuffer html) Appends text for the first, previous, next, or last link on an HTMLTable
IMagicRequest	execute(HttpServletRequest request, HttpServletResponse response, DataEngineServlet servlet) execute method comment.

Methods inherited from class planetj.magic.RowCollectionRequest

getRowCollection, getRowCollectionSessionId

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

Field Detail

PAGE_FIRST

public static final short PAGE_FIRST

See Also:

Constant Field Values

PAGE_PREVIOUS

public static final short PAGE_PREVIOUS

See Also:

Constant Field Values

PAGE_NEXT

public static final short PAGE_NEXT

See Also:

Constant Field Values

PAGE_LAST

public static final short PAGE_LAST

See Also:

Constant Field Values

REQUEST_ID

public static final java.lang.String REQUEST_ID

See Also:

Constant Field Values

Constructor Detail

PageRequest

public PageRequest(RowCollection rc,
                   HttpServletRequest request,
                   HttpServletResponse response)

Create a new PageRequest for the given RC

Method Detail

appendText

public static java.lang.StringBuffer appendText(java.lang.String rcKey,
                                                short type,
                                                boolean link,
                                                java.lang.StringBuffer html)

Appends text for the first, previous, next, or last link on an HTMLTable

Parameters:

rcKey - The navigation key of the RowCollection that is being paged

type - Either PAGE_FIRST, PAGE_PREVIOUS, PAGE_NEXT, or PAGE_LAST

link - If the text should be a link or not

html - The StringBuffer to append to

execute

public IMagicRequest execute(HttpServletRequest request,
                             HttpServletResponse response,
                             DataEngineServlet servlet)
                      throws CMException

execute method comment.

Specified by:

execute in interface IMagicRequest

Specified by:

execute in class AbstractMagicRequest

Throws:

CMException

appendText

public static java.lang.StringBuffer appendText(RowCollection rc,
                                                HTMLTable table,
                                                boolean useText,
                                                java.lang.StringBuffer html,
                                                HttpServletRequest req)

Appends text for the first, previous, next, or last link on an HTMLTable

Parameters:

rc - The RowCollection that is being paged

table - The HTMLTable which is rendering the row collection

html - The StringBuffer to append to