atg.search.formhandlers

Class QueryFormHandler

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.droplet.EmptyFormHandler

atg.droplet.GenericFormHandler

atg.search.formhandlers.BaseSearchFormHandler

atg.search.formhandlers.PagedRequestFormHandler

atg.search.formhandlers.QueryFormHandler

All Implemented Interfaces:

atg.core.logging.Logging, atg.core.logging.TraceLogging, DropletFormHandler, atg.naming.AbsoluteNameable, NameContextBindingListener, NameContextElement, atg.naming.NameContextParentable, NameResolver, AdminableService, atg.nucleus.Configured, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, VariableArgumentApplicationLogging, ComponentNameResolver, Service, ServiceListener, java.util.EventListener

public class QueryFormHandler
extends PagedRequestFormHandler

This form handler issues query requests. See QueryRequest.

Field Summary

Fields

Modifier and Type	Field and Description
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

Constructors

Constructor and Description
QueryFormHandler()

Method Summary

Modifier and Type	Method and Description
protected SearchRequest	beforeSearch(SearchRequest pRequest, atg.search.client.SearchSession pSession) before the search, handle the case where this is a facet search request
SearchRequest	getPreviousSearchRequest()
protected SearchRequest	stringToRequest(java.lang.String pString) Converts XML into a request object.

Methods inherited from class atg.search.formhandlers.PagedRequestFormHandler

getGoToPage, getPagesAvailable, handleGoToPage, setGoToPage

Methods inherited from class atg.search.formhandlers.BaseSearchFormHandler

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

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

Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, 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, wait, wait, wait

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Constructor Detail

QueryFormHandler

public QueryFormHandler()

Method Detail

stringToRequest

protected SearchRequest stringToRequest(java.lang.String pString)

Description copied from class: BaseSearchFormHandler

Converts XML into a request object. Useful for "Load old request from file" feature.

Specified by:

stringToRequest in class BaseSearchFormHandler

Parameters:

pString - XML request string

Returns:

request object of the appropriate type

getPreviousSearchRequest

public SearchRequest getPreviousSearchRequest()

beforeSearch

protected SearchRequest beforeSearch(SearchRequest pRequest,
                                     atg.search.client.SearchSession pSession)

before the search, handle the case where this is a facet search request

Overrides:

beforeSearch in class PagedRequestFormHandler

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