public class SiteScopeFormHandler
extends atg.droplet.GenericFormHandler
The site scope is used for filtering the results by site.
SearchState
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 |
CLASS_VERSION, PARAM_DEFER_FORWARD_OR_REDIRECT, PARAM_USE_FORWARDS
Constructor and Description |
---|
SiteScopeFormHandler() |
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) . |
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
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 java.lang.String mSiteScope
protected atg.commerce.csr.catalog.endeca.SearchState mSearchState
protected java.lang.String mChangeSiteScopeSuccessURL
protected java.lang.String mChangeSiteScopeErrorURL
public java.lang.String getSiteScope()
public void setSiteScope(java.lang.String pSiteScope)
handleChangeSiteScope(DynamoHttpServletRequest, DynamoHttpServletResponse)
.public atg.commerce.csr.catalog.endeca.SearchState getSearchState()
SearchState
objectpublic void setSearchState(atg.commerce.csr.catalog.endeca.SearchState pSearchState)
public java.lang.String getChangeSiteScopeErrorURL()
public void setChangeSiteScopeErrorURL(java.lang.String pChangeSiteScopeErrorURL)
public java.lang.String getChangeSiteScopeSuccessURL()
public void setChangeSiteScopeSuccessURL(java.lang.String pChangeSiteScopeSuccessURL)
public boolean handleChangeSiteScope(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
javax.servlet.ServletException
java.io.IOException
protected void changeSiteScope(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse)
pRequest
- pResponse
- protected void preChangeSiteScope(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse)
pRequest
- pResponse
- protected void postChangeSiteScope(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse)
pRequest
- pResponse
-