atg.svc.agent.ui.formhandlers
Class CustomerSearchTreeQueryFormHandler

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.TreeQueryFormHandler
                              atg.svc.agent.ui.formhandlers.SearchFormHandler
                                  atg.svc.agent.ui.formhandlers.CustomerSearchTreeQueryFormHandler

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 CustomerSearchTreeQueryFormHandler
extends atg.svc.agent.ui.formhandlers.SearchFormHandler

This class is used to house the properties that seed the TreeQueryRequst.fields[] from the form's hidden input.

Field Summary

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

CustomerSearchTreeQueryFormHandler()

Method Summary

java.lang.String	getEmailProperty() Returns the mEmailProperty
java.lang.String	getFirstNameProperty() Returns the mFirstNameProperty
java.lang.String	getLastNameProperty() Returns the mLastNameProperty
java.lang.String	getLoginProperty() Returns the mLoginProperty
java.lang.String	getMaxSearchResults() Returns the mMaxSearchResults
java.lang.String	getMaxSearchResultsPerPage() Returns the mMaxSearchResultsPerPage
java.lang.String	getPhoneNumberProperty() Returns the mPhoneNumberProperty
java.lang.String	getPostalCodeProperty() Returns the mPostalCodeProperty
boolean	handleClearForm(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Over rides the super clearForm method so that the search response and request can be cleared out of the AgentSearchRequestTracker
void	setEmailProperty(java.lang.String pEmailProperty) Sets the mEmailProperty
void	setFirstNameProperty(java.lang.String pFirstNameProperty) Sets the mFirstNameProperty
void	setLastNameProperty(java.lang.String pLastNameProperty) Sets the mLastNameProperty
void	setLoginProperty(java.lang.String pLoginProperty) Sets the mLoginProperty
void	setMaxSearchResults(java.lang.String pMaxSearchResults) Sets the mMaxSearchResults
void	setMaxSearchResultsPerPage(java.lang.String pMaxSearchResultsPerPage) Sets the mMaxSearchResultsPerPage
void	setPhoneNumberProperty(java.lang.String pPhoneNumberProperty) Sets the mPhoneNumberProperty
void	setPostalCodeProperty(java.lang.String pPostalCodeProperty) Sets the mPostalCodeProperty

Methods inherited from class atg.svc.agent.ui.formhandlers.SearchFormHandler

afterSearch, getAgentSearchRequestTrackerPath, setAgentSearchRequestTrackerPath

Methods inherited from class atg.search.formhandlers.TreeQueryFormHandler

getPreviousSearchRequest, stringToRequest

Methods inherited from class atg.search.formhandlers.PagedRequestFormHandler

beforeSearch, getGoToPage, getPagesAvailable, handleGoToPage, setGoToPage

Methods inherited from class atg.search.formhandlers.BaseSearchFormHandler

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

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

public static java.lang.String CLASS_VERSION

Class version string

Constructor Detail

CustomerSearchTreeQueryFormHandler

public CustomerSearchTreeQueryFormHandler()

Method Detail

getMaxSearchResults

public java.lang.String getMaxSearchResults()

Returns the mMaxSearchResults

setMaxSearchResults

public void setMaxSearchResults(java.lang.String pMaxSearchResults)

Sets the mMaxSearchResults

getMaxSearchResultsPerPage

public java.lang.String getMaxSearchResultsPerPage()

Returns the mMaxSearchResultsPerPage

setMaxSearchResultsPerPage

public void setMaxSearchResultsPerPage(java.lang.String pMaxSearchResultsPerPage)

Sets the mMaxSearchResultsPerPage

getFirstNameProperty

public java.lang.String getFirstNameProperty()

Returns the mFirstNameProperty

setFirstNameProperty

public void setFirstNameProperty(java.lang.String pFirstNameProperty)

Sets the mFirstNameProperty

getLastNameProperty

public java.lang.String getLastNameProperty()

Returns the mLastNameProperty

setLastNameProperty

public void setLastNameProperty(java.lang.String pLastNameProperty)

Sets the mLastNameProperty

getLoginProperty

public java.lang.String getLoginProperty()

Returns the mLoginProperty

setLoginProperty

public void setLoginProperty(java.lang.String pLoginProperty)

Sets the mLoginProperty

getEmailProperty

public java.lang.String getEmailProperty()

Returns the mEmailProperty

setEmailProperty

public void setEmailProperty(java.lang.String pEmailProperty)

Sets the mEmailProperty

getPostalCodeProperty

public java.lang.String getPostalCodeProperty()

Returns the mPostalCodeProperty

setPostalCodeProperty

public void setPostalCodeProperty(java.lang.String pPostalCodeProperty)

Sets the mPostalCodeProperty

getPhoneNumberProperty

public java.lang.String getPhoneNumberProperty()

Returns the mPhoneNumberProperty

setPhoneNumberProperty

public void setPhoneNumberProperty(java.lang.String pPhoneNumberProperty)

Sets the mPhoneNumberProperty

handleClearForm

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

Over rides the super clearForm method so that the search response and request can be cleared out of the AgentSearchRequestTracker

Overrides:

handleClearForm in class atg.search.formhandlers.BaseSearchFormHandler

Parameters:

pRequest - the dynamo request

pResponse - the dynamo response

Throws:

javax.servlet.ServletException

java.io.IOException

See Also:

BaseSearchFormHandler.setClearFormURL(String)