atg.commerce.csr.search
Class OrderSearchTreeQueryFormHandler

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.commerce.csr.search.OrderSearchTreeQueryFormHandler

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

This class performs pre-processing on the request object before a search. Also stores the state of the address radio button, and the advanced search area

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

OrderSearchTreeQueryFormHandler()

Method Summary

protected atg.search.routing.command.search.SearchResponse	afterSearch(atg.search.routing.command.search.SearchRequest pRequest, atg.search.routing.command.search.SearchResponse pResults, atg.search.client.SearchSession pSession) As this form handler is request scoped, the state of any UI properties need to be saved in a window scoped component.
java.lang.String	getAddressPicker() Returns the value of the address picker radio button on the Order Search UI.
java.lang.String	getAdvancedAddressLine1Property() Returns the mAdvancedAddressLine1Property
java.lang.String	getAdvancedAddressLine2Property() Returns the mAdvancedAddressLine2Property
java.lang.String	getAdvancedCityProperty() Returns the mAdvancedCityProperty
java.lang.String	getAdvancedCountryProperty() Returns the mAdvancedCountryProperty
java.lang.String	getAdvancedFirstNameProperty() Returns the mAdvancedFirstNameProperty
java.lang.String	getAdvancedLastNameProperty() Returns the mAdvancedLastNameProperty
java.lang.String	getAdvancedPhoneProperty() Returns the mAdvancedPhoneProperty
java.lang.String	getAdvancedPostalCodeProperty() Returns the mAdvancedPostalCodeProperty
java.lang.String	getAdvancedStateProperty() Returns the mAdvancedStateProperty
java.lang.String	getContainsSKUProperty() Returns the mContainsSKUProperty
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	getOrderIdProperty() Returns the mOrderIdProperty
java.lang.String	getOrderStatusProperty() Returns the mOrderStatusProperty
java.lang.String	getPaymentGroupsProperty() Returns the mPaymentGroupsProperty
java.lang.String	getShippingGroupsProperty() Returns the mShippingGroupsProperty
java.lang.String	getSubmittedDateProperty() Returns the mSubmittedDate
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
boolean	isAdvancedSearch() Returns the mIsAdvancedSearch
void	setAddressPicker(java.lang.String pAddressPicker) This will store the value of the address picker radio button on the order search UI Sets the mAddressPicker
void	setAdvancedAddressLine1Property(java.lang.String pAdvancedAddressLine1Property) Sets the mAdvancedAddressLine1Property
void	setAdvancedAddressLine2Property(java.lang.String pAdvancedAddressLine2Property) Sets the mAdvancedAddressLine2Property
void	setAdvancedCityProperty(java.lang.String pAdvancedCityProperty) Sets the mAdvancedCityProperty
void	setAdvancedCountryProperty(java.lang.String pAdvancedCountryProperty) Sets the mAdvancedCountryProperty
void	setAdvancedFirstNameProperty(java.lang.String pAdvancedFirstNameProperty) Sets the mAdvancedFirstNameProperty
void	setAdvancedLastNameProperty(java.lang.String pAdvancedLastNameProperty) Sets the mAdvancedLastNameProperty
void	setAdvancedPhoneProperty(java.lang.String pAdvancedPhoneProperty) Sets the mAdvancedPhoneProperty
void	setAdvancedPostalCodeProperty(java.lang.String pAdvancedPostalCodeProperty) Sets the mAdvancedPostalCodeProperty
void	setAdvancedSearch(boolean pIsAdvancedSearch) Sets the mIsAdvancedSearch
void	setAdvancedStateProperty(java.lang.String pAdvancedStateProperty) Sets the mAdvancedStateProperty
void	setContainsSKUProperty(java.lang.String pContainsSKUProperty) Sets the mContainsSKUProperty
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	setOrderIdProperty(java.lang.String pOrderIdProperty) Sets the mOrderIdProperty
void	setOrderStatusProperty(java.lang.String pOrderStatusProperty) Sets the mOrderStatusProperty
void	setPaymentGroupsProperty(java.lang.String pPaymentGroupsProperty) Sets the mPaymentGroupsProperty
void	setShippingGroupsProperty(java.lang.String pShippingGroupsProperty) Sets the mShippingGroupsProperty
void	setSubmittedDateProperty(java.lang.String pSubmittedDateProperty) Sets the mSubmittedDate

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

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

OrderSearchTreeQueryFormHandler

public OrderSearchTreeQueryFormHandler()

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

getAddressPicker

public java.lang.String getAddressPicker()

Returns the value of the address picker radio button on the Order Search UI. This is to reset the address picker radio button after a page reload Returns the mAddressPicker

setAddressPicker

public void setAddressPicker(java.lang.String pAddressPicker)

This will store the value of the address picker radio button on the order search UI Sets the mAddressPicker

isAdvancedSearch

public boolean isAdvancedSearch()

Returns the mIsAdvancedSearch

setAdvancedSearch

public void setAdvancedSearch(boolean pIsAdvancedSearch)

Sets the mIsAdvancedSearch

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

getOrderIdProperty

public java.lang.String getOrderIdProperty()

Returns the mOrderIdProperty

setOrderIdProperty

public void setOrderIdProperty(java.lang.String pOrderIdProperty)

Sets the mOrderIdProperty

getContainsSKUProperty

public java.lang.String getContainsSKUProperty()

Returns the mContainsSKUProperty

setContainsSKUProperty

public void setContainsSKUProperty(java.lang.String pContainsSKUProperty)

Sets the mContainsSKUProperty

getOrderStatusProperty

public java.lang.String getOrderStatusProperty()

Returns the mOrderStatusProperty

setOrderStatusProperty

public void setOrderStatusProperty(java.lang.String pOrderStatusProperty)

Sets the mOrderStatusProperty

getSubmittedDateProperty

public java.lang.String getSubmittedDateProperty()

Returns the mSubmittedDate

setSubmittedDateProperty

public void setSubmittedDateProperty(java.lang.String pSubmittedDateProperty)

Sets the mSubmittedDate

getAdvancedFirstNameProperty

public java.lang.String getAdvancedFirstNameProperty()

Returns the mAdvancedFirstNameProperty

setAdvancedFirstNameProperty

public void setAdvancedFirstNameProperty(java.lang.String pAdvancedFirstNameProperty)

Sets the mAdvancedFirstNameProperty

getAdvancedLastNameProperty

public java.lang.String getAdvancedLastNameProperty()

Returns the mAdvancedLastNameProperty

setAdvancedLastNameProperty

public void setAdvancedLastNameProperty(java.lang.String pAdvancedLastNameProperty)

Sets the mAdvancedLastNameProperty

getAdvancedCountryProperty

public java.lang.String getAdvancedCountryProperty()

Returns the mAdvancedCountryProperty

setAdvancedCountryProperty

public void setAdvancedCountryProperty(java.lang.String pAdvancedCountryProperty)

Sets the mAdvancedCountryProperty

getAdvancedAddressLine1Property

public java.lang.String getAdvancedAddressLine1Property()

Returns the mAdvancedAddressLine1Property

setAdvancedAddressLine1Property

public void setAdvancedAddressLine1Property(java.lang.String pAdvancedAddressLine1Property)

Sets the mAdvancedAddressLine1Property

getAdvancedAddressLine2Property

public java.lang.String getAdvancedAddressLine2Property()

Returns the mAdvancedAddressLine2Property

setAdvancedAddressLine2Property

public void setAdvancedAddressLine2Property(java.lang.String pAdvancedAddressLine2Property)

Sets the mAdvancedAddressLine2Property

getAdvancedCityProperty

public java.lang.String getAdvancedCityProperty()

Returns the mAdvancedCityProperty

setAdvancedCityProperty

public void setAdvancedCityProperty(java.lang.String pAdvancedCityProperty)

Sets the mAdvancedCityProperty

getAdvancedStateProperty

public java.lang.String getAdvancedStateProperty()

Returns the mAdvancedStateProperty

setAdvancedStateProperty

public void setAdvancedStateProperty(java.lang.String pAdvancedStateProperty)

Sets the mAdvancedStateProperty

getAdvancedPostalCodeProperty

public java.lang.String getAdvancedPostalCodeProperty()

Returns the mAdvancedPostalCodeProperty

setAdvancedPostalCodeProperty

public void setAdvancedPostalCodeProperty(java.lang.String pAdvancedPostalCodeProperty)

Sets the mAdvancedPostalCodeProperty

getAdvancedPhoneProperty

public java.lang.String getAdvancedPhoneProperty()

Returns the mAdvancedPhoneProperty

setAdvancedPhoneProperty

public void setAdvancedPhoneProperty(java.lang.String pAdvancedPhoneProperty)

Sets the mAdvancedPhoneProperty

getPaymentGroupsProperty

public java.lang.String getPaymentGroupsProperty()

Returns the mPaymentGroupsProperty

setPaymentGroupsProperty

public void setPaymentGroupsProperty(java.lang.String pPaymentGroupsProperty)

Sets the mPaymentGroupsProperty

getShippingGroupsProperty

public java.lang.String getShippingGroupsProperty()

Returns the mShippingGroupsProperty

setShippingGroupsProperty

public void setShippingGroupsProperty(java.lang.String pShippingGroupsProperty)

Sets the mShippingGroupsProperty

afterSearch

protected atg.search.routing.command.search.SearchResponse afterSearch(atg.search.routing.command.search.SearchRequest pRequest,
                                                                       atg.search.routing.command.search.SearchResponse pResults,
                                                                       atg.search.client.SearchSession pSession)

As this form handler is request scoped, the state of any UI properties need to be saved in a window scoped component. This includes the isAdvancedSearch and AddressPicker properties.

Overrides:

afterSearch in class atg.svc.agent.ui.formhandlers.SearchFormHandler

Parameters:

pRequest - the client query request

pResults - the search results

pSession - the search session

Returns:

the potentially modified search results

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)