atg.projects.store.assembler
Class SearchFormHandler

java.lang.Object
  atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      atg.nucleus.GenericService
          atg.droplet.EmptyFormHandler
              atg.droplet.GenericFormHandler
                  atg.projects.store.assembler.SearchFormHandler

All Implemented Interfaces:

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 SearchFormHandler
extends atg.droplet.GenericFormHandler

The purpose of this form handler is to add some additional properties to Endeca-specific search. Typically, Endeca's Assembler module assembles parameters from a request but we don't want to follow this approach for additional properties/parameters. The form handler should be used instead.

Field Summary

protected static java.lang.String

CLASS_VERSION Class version string

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

SearchFormHandler()

Method Summary

SearchedSites	getSearchedSites()
java.lang.String[]	getSiteIds() Gets site ids which is used as search constraints.
java.lang.String	getSiteScope()
boolean	handleSearch(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Contains logic that will be executed when a search is performed.
void	setSearchedSites(SearchedSites pSearchedSites)
void	setSiteIds(java.lang.String[] pSiteIds) Sets site ids to use them as search constraints.
void	setSiteScope(java.lang.String pSiteScope)

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

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

Field Detail

CLASS_VERSION

protected static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

Constructor Detail

SearchFormHandler

public SearchFormHandler()

Method Detail

getSiteIds

public java.lang.String[] getSiteIds()

Gets site ids which is used as search constraints.

setSiteIds

public void setSiteIds(java.lang.String[] pSiteIds)

Sets site ids to use them as search constraints.

Parameters:

pSiteIds - list of site ids to set

getSearchedSites

public SearchedSites getSearchedSites()

Returns:

A bean thats used to indicate the scope of the current search.

setSearchedSites

public void setSearchedSites(SearchedSites pSearchedSites)

Parameters:

Set - a new SearchedSites bean.

getSiteScope

public java.lang.String getSiteScope()

Returns:

A parameter used to indicate the current scope of the search is correct. Set by the form invoking the handler.

setSiteScope

public void setSiteScope(java.lang.String pSiteScope)

Parameters:

Set - a new siteScope.

handleSearch

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

Contains logic that will be executed when a search is performed.

Parameters:

pRequest - The current request

pResponse - The current response

Returns:

Throws:

java.io.IOException

javax.servlet.ServletException