public abstract class PagedRequestFormHandler extends BaseSearchFormHandler
#handleGoToPage(Integer)
,Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CLASS_VERSION |
PARAM_DEFER_FORWARD_OR_REDIRECT, PARAM_USE_FORWARDS
SERVICE_INFO_KEY
DEFAULT_LOG_TRACE_STATUS
DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS
Constructor and Description |
---|
PagedRequestFormHandler() |
Modifier and Type | Method and Description |
---|---|
protected SearchRequest |
beforeSearch(SearchRequest pRequest,
atg.search.client.SearchSession pSession)
When using saveRequest (see
SearchRequest.setSaveRequest(boolean) ),
if this is a paging request this method will replace the current request with the last one, and update
it to reflect the correct page number. |
java.lang.Integer |
getGoToPage()
The 1-based page that will be retrieved next, or that has already been retrieved.
|
int |
getPagesAvailable()
Returns the number of available pages based on the type of paging, page size, and total results.
|
boolean |
handleGoToPage(DynamoHttpServletRequest pRequest,
DynamoHttpServletResponse pResponse)
Called when user is iterating through pages of results.
|
void |
setGoToPage(java.lang.Integer pPageNum)
Sets the 1-based page that will be retrieved next.
|
afterSearch, createSearchSession, doRedirect, doRedirect, getClearFormURL, getEnvironmentTargets, getErrorURL, getLogicalPartitionNames, getRedirect, getRedirects, getRequestFile, getResultsFetcher, getSearchAssetTools, getSearchClient, getSearchContext, getSearchException, getSearchExceptions, getSearchRedirectProcessors, getSearchRequest, getSearchRequestProcessors, getSearchResponse, getSearchResponseProcessors, getSearchSession, getSuccessURL, getSuccessURLDynamicParams, getUserProfile, handleClearForm, handleConnect, handleErrorCondition, handleLoad, handleLoadAndSearch, handleSearch, isForceDeployedOnlyAssets, isLoggingVerboseResponseXML, isPageRequest, isRedirectEnabled, isShowDetailedResults, isShowXml, search, setClearFormURL, setErrorURL, setForceDeployedOnlyAssets, setLoggingVerboseResponseXML, setPageRequest, setRedirectEnabled, setRequestFile, setResultsFetcher, setSearchAssetTools, setSearchContext, setSearchExceptions, setSearchRedirectProcessors, setSearchRequest, setSearchRequestProcessors, setSearchResponse, setSearchResponseProcessors, setShowDetailedResults, setShowXml, setSuccessURL, setSuccessURLDynamicParams, setUserProfile, stringToRequest
addFormException, addUncheckedFormException, afterSet, beforeSet, checkFormRedirect, createFormSubmissionMessage, getCancelURL, getCheckForValidSession, getFormError, getFormExceptions, getFormName, getMessagePort, getMessageSource, getMessageType, getPropertyExceptions, getSendMessages, getUncheckedFormExceptions, handleCancel, handleFormException, handleUncheckedFormException, hasUncheckedFormExceptions, isDeferForwardsAndRedirects, isRestorableForm, isUseForwards, isValidSession, redirectOrForward, resetFormExceptions, setCancelURL, setCheckForValidSession, setDeferForwardsAndRedirects, setFormName, setMessagePort, setMessageSource, setMessageType, setRestorableForm, setSendMessages, setUseForwards
afterGet, beforeGet
addLogListener, createAdminServlet, doStartService, doStopService, getAbsoluteName, getAdminServlet, getAdminServletOutputStreamEncoding, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isAdminServletUseServletOutputStream, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, reResolveThis, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setAdminServletOutputStreamEncoding, setAdminServletUseServletOutputStream, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService
vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning
protected SearchRequest beforeSearch(SearchRequest pRequest, atg.search.client.SearchSession pSession)
SearchRequest.setSaveRequest(boolean)
),
if this is a paging request this method will replace the current request with the last one, and update
it to reflect the correct page number. If this is not a paging request this method ensures that any
previously-saved page number is cleared from the SearchSession.beforeSearch
in class BaseSearchFormHandler
pRequest
- current search requestpSession
- search sessionpublic int getPagesAvailable()
PagedRequest.setFastPaging(Boolean)
),
this is the number of pages available; if Fast paging is enabled, this is the number of pages visited so far.public java.lang.Integer getGoToPage()
public void setGoToPage(java.lang.Integer pPageNum)
pPageNum
- The 1-based page number.handleGoToPage(atg.servlet.DynamoHttpServletRequest, atg.servlet.DynamoHttpServletResponse)
public boolean handleGoToPage(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
pRequest
- the servlet's requestpResponse
- the servlet's responsejavax.servlet.ServletException
- if there was an error while executing the codejava.io.IOException
- if there was an error with servlet io