atg.search.query.formhandlers
Class SearchContext

java.lang.Object
  atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      atg.nucleus.GenericService
          atg.search.query.formhandlers.SearchContext

All Implemented Interfaces:

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

public class SearchContext
extends GenericService

This component provides a place to store session data for use by search form handlers.

Field Summary

static java.lang.String

CLASS_VERSION Class version string

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

SearchContext()

Method Summary

java.lang.String[]	getAdditionalOptionSets() Set list of non-default option sets that should be available in the session.
java.util.Map	getAttributes() Get the attribute map.
ClientRequest	getClientRequest() Get the client request from the most recent search.
Results	getResults() Get the most recent results object or null
SearchSession	getSearchSession() Get the search session used to track user in ATG Search
void	setAdditionalOptionSets(java.lang.String[] pAdditionalOptionSets) Set list of non-default option sets that should be available in the session.
void	setClientRequest(ClientRequest pClientRequest) Set the client request.
void	setResults(Results pResults) Set the most recent Results object
void	setSearchSession(SearchSession pSearchSession) Set the search session used to track user in ATG Search

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

Class version string

Constructor Detail

SearchContext

public SearchContext()

Method Detail

getSearchSession

public SearchSession getSearchSession()

Get the search session used to track user in ATG Search

Returns:

the ATG Search session

setSearchSession

public void setSearchSession(SearchSession pSearchSession)

Set the search session used to track user in ATG Search

Parameters:

pSearchSession - the ATG Search session

setClientRequest

public void setClientRequest(ClientRequest pClientRequest)

Set the client request. When set, this is the request from the most recent search.

Parameters:

pClientRequest - the client request

getClientRequest

public ClientRequest getClientRequest()

Get the client request from the most recent search.

Returns:

the most recent client request or null

setResults

public void setResults(Results pResults)

Set the most recent Results object

Parameters:

pResults - the most recent results object

getResults

public Results getResults()

Get the most recent results object or null

Returns:

the most recent results object or null

getAdditionalOptionSets

public java.lang.String[] getAdditionalOptionSets()

Set list of non-default option sets that should be available in the session. This list includes option sets for all query types.

Parameters:

pAdditionalOptionSets - a list of option sets

setAdditionalOptionSets

public void setAdditionalOptionSets(java.lang.String[] pAdditionalOptionSets)

Set list of non-default option sets that should be available in the session. This list includes option sets for all query types.

Parameters:

pAdditionalOptionSets - a list of option sets

getAttributes

public java.util.Map getAttributes()

Get the attribute map. This value is for use by subclasses of the BaseSearchFormHandler to store session scoped data.

Returns:

the attribute map