atg.commerce.csr.catalog.endeca

Class SiteScopeFormHandler

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.droplet.EmptyFormHandler

atg.droplet.GenericFormHandler

atg.commerce.csr.catalog.endeca.SiteScopeFormHandler

All Implemented Interfaces:

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

public class SiteScopeFormHandler
extends atg.droplet.GenericFormHandler

This form handler is used to set the siteScope value in the SearchState.

The site scope is used for filtering the results by site.

See Also:

SearchState

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	mChangeSiteScopeErrorURL
protected java.lang.String	mChangeSiteScopeSuccessURL
protected atg.commerce.csr.catalog.endeca.SearchState	mSearchState
protected java.lang.String	mSiteScope

Fields inherited from class atg.droplet.GenericFormHandler

CLASS_VERSION, 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
SiteScopeFormHandler()

Method Summary

Modifier and Type	Method and Description
protected void	changeSiteScope(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Called by the handler to change the site scope
java.lang.String	getChangeSiteScopeErrorURL() Returns the url used when an error occurs attempting to change the site scope.
java.lang.String	getChangeSiteScopeSuccessURL() Returns the url used when the site scope has been successfully changed
atg.commerce.csr.catalog.endeca.SearchState	getSearchState() Returns a reference to the window scope SearchState object
java.lang.String	getSiteScope() Returns the site scope that will be set in the SearchState
boolean	handleChangeSiteScope(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse)
protected void	postChangeSiteScope(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Called by the handler after changing the site scope
protected void	preChangeSiteScope(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Called by the handler prior to changing the site scope
void	setChangeSiteScopeErrorURL(java.lang.String pChangeSiteScopeErrorURL) Sets the url used when an error occurs attempting to change the site scope.
void	setChangeSiteScopeSuccessURL(java.lang.String pChangeSiteScopeSuccessURL) Sets the url used when the site scope has been successfully changed
void	setSearchState(atg.commerce.csr.catalog.endeca.SearchState pSearchState)
void	setSiteScope(java.lang.String pSiteScope) Sets the site scope that will be set in the SearchState by handleChangeSiteScope(DynamoHttpServletRequest, DynamoHttpServletResponse).

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

mSiteScope

protected java.lang.String mSiteScope

mSearchState

protected atg.commerce.csr.catalog.endeca.SearchState mSearchState

mChangeSiteScopeSuccessURL

protected java.lang.String mChangeSiteScopeSuccessURL

mChangeSiteScopeErrorURL

protected java.lang.String mChangeSiteScopeErrorURL

Constructor Detail

SiteScopeFormHandler

public SiteScopeFormHandler()

Method Detail

getSiteScope

public java.lang.String getSiteScope()

Returns the site scope that will be set in the SearchState

setSiteScope

public void setSiteScope(java.lang.String pSiteScope)

Sets the site scope that will be set in the SearchState by handleChangeSiteScope(DynamoHttpServletRequest, DynamoHttpServletResponse).

getSearchState

public atg.commerce.csr.catalog.endeca.SearchState getSearchState()

Returns a reference to the window scope SearchState object

setSearchState

public void setSearchState(atg.commerce.csr.catalog.endeca.SearchState pSearchState)

getChangeSiteScopeErrorURL

public java.lang.String getChangeSiteScopeErrorURL()

Returns the url used when an error occurs attempting to change the site scope.

setChangeSiteScopeErrorURL

public void setChangeSiteScopeErrorURL(java.lang.String pChangeSiteScopeErrorURL)

Sets the url used when an error occurs attempting to change the site scope.

getChangeSiteScopeSuccessURL

public java.lang.String getChangeSiteScopeSuccessURL()

Returns the url used when the site scope has been successfully changed

setChangeSiteScopeSuccessURL

public void setChangeSiteScopeSuccessURL(java.lang.String pChangeSiteScopeSuccessURL)

Sets the url used when the site scope has been successfully changed

handleChangeSiteScope

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

Throws:

javax.servlet.ServletException

java.io.IOException

changeSiteScope

protected void changeSiteScope(atg.servlet.DynamoHttpServletRequest pRequest,
                               atg.servlet.DynamoHttpServletResponse pResponse)

Called by the handler to change the site scope

Parameters:

pRequest -

pResponse -

preChangeSiteScope

protected void preChangeSiteScope(atg.servlet.DynamoHttpServletRequest pRequest,
                                  atg.servlet.DynamoHttpServletResponse pResponse)

Called by the handler prior to changing the site scope

Parameters:

pRequest -

pResponse -

postChangeSiteScope

protected void postChangeSiteScope(atg.servlet.DynamoHttpServletRequest pRequest,
                                   atg.servlet.DynamoHttpServletResponse pResponse)

Called by the handler after changing the site scope

Parameters:

pRequest -

pResponse -