atg.search.formhandlers
Class PagedRequestFormHandler

java.lang.Object
  atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      atg.nucleus.GenericService
          atg.droplet.EmptyFormHandler
              atg.droplet.GenericFormHandler
                  atg.search.formhandlers.BaseSearchFormHandler
                      atg.search.formhandlers.PagedRequestFormHandler

All Implemented Interfaces:

DropletFormHandler, NameContextBindingListener, NameContextElement, NameResolver, AdminableService, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, VariableArgumentApplicationLogging, ComponentNameResolver, Service, ServiceListener, java.util.EventListener

Direct Known Subclasses:

BrowseFormHandler, QueryFormHandler, SimilarDocsFormHandler, StructuredQueryFormHandler, TreeQueryFormHandler

public abstract class PagedRequestFormHandler
extends BaseSearchFormHandler

This is a formhandler for paged requests. Provides the number of pages available (after the first request), a property with a handler for paging (see #handleGoToPage(Integer),

Field Summary

static java.lang.String

CLASS_VERSION

Fields inherited from class atg.droplet.GenericFormHandler

PARAM_DEFER_FORWARD_OR_REDIRECT, PARAM_USE_FORWARDS

Fields inherited from class atg.nucleus.GenericService

SERVICE_INFO_KEY

Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging

DEFAULT_LOG_TRACE_STATUS

Fields inherited from interface atg.nucleus.logging.ApplicationLogging

DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS

Constructor Summary

PagedRequestFormHandler()

Method Summary

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.

Methods inherited from class atg.search.formhandlers.BaseSearchFormHandler

afterSearch, createSearchSession, doRedirect, getClearFormURL, getEnvironmentTargets, getErrorURL, getLogicalPartitionNames, getRedirect, getRedirects, getRequestFile, getResultsFetcher, getSearchAssetTools, getSearchClient, getSearchContext, getSearchException, getSearchExceptions, getSearchRedirectProcessors, getSearchRequest, getSearchRequestProcessors, getSearchResponse, getSearchResponseProcessors, getSearchSession, getSuccessURL, 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, setUserProfile, stringToRequest

Methods inherited from class atg.droplet.GenericFormHandler

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

Methods inherited from class atg.droplet.EmptyFormHandler

afterGet, beforeGet

Methods inherited from class atg.nucleus.GenericService

addLogListener, createAdminServlet, doStartService, doStopService, getAbsoluteName, getAdminServlet, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, 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, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService

Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Constructor Detail

PagedRequestFormHandler

public PagedRequestFormHandler()

Method Detail

beforeSearch

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. If this is not a paging request this method ensures that any previously-saved page number is cleared from the SearchSession.

Overrides:

beforeSearch in class BaseSearchFormHandler

Parameters:

pRequest - current search request

pSession - search session

Returns:

the passed-in request, or the previous request with an updated page number and chain token

getPagesAvailable

public int getPagesAvailable()

Returns the number of available pages based on the type of paging, page size, and total results. It will always be >= 1. If Fast paging is disabled (the default; see PagedRequest.setFastPaging(Boolean)), this is the number of pages available; if Fast paging is enabled, this is the number of pages visited so far.

Returns:

number of available pages of answers based on the type of paging and page size and total results, always >= 1

getGoToPage

public java.lang.Integer getGoToPage()

The 1-based page that will be retrieved next, or that has already been retrieved.

Returns:

The 1-based page

setGoToPage

public void setGoToPage(java.lang.Integer pPageNum)

Sets the 1-based page that will be retrieved next. This sets the page number on the session and request.

Parameters:

pPageNum - The 1-based page number.

See Also:

handleGoToPage(atg.servlet.DynamoHttpServletRequest, atg.servlet.DynamoHttpServletResponse)

handleGoToPage

public boolean handleGoToPage(DynamoHttpServletRequest pRequest,
                              DynamoHttpServletResponse pResponse)
                       throws javax.servlet.ServletException,
                              java.io.IOException

Called when user is iterating through pages of results.

Parameters:

pRequest - the servlet's request

pResponse - the servlet's response

Returns:

false to stop form processing

Throws:

javax.servlet.ServletException - if there was an error while executing the code

java.io.IOException - if there was an error with servlet io