atg.commerce.csr.gifts
Class GiftlistTableFormHandler

java.lang.Object
  atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      atg.nucleus.GenericService
          atg.droplet.EmptyFormHandler
              atg.droplet.GenericFormHandler
                  atg.droplet.TransactionalFormHandler
                      atg.web.formhandlers.ApplicationFormHandler
                          atg.svc.ui.formhandlers.ServiceFormHandler
                              atg.svc.ui.formhandlers.FrameworkBaseFormHandler
                                  atg.svc.search.PagingTableFormHandler
                                      atg.svc.search.RepositoryQueryTableFormHandler
                                          atg.commerce.csr.gifts.GiftlistTableFormHandler

All Implemented Interfaces:

atg.droplet.DropletFormHandler, atg.naming.NameContextBindingListener, atg.naming.NameContextElement, atg.naming.NameResolver, atg.nucleus.AdminableService, 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, atg.svc.ui.formhandlers.FormHandlerConstants, java.util.EventListener

public class GiftlistTableFormHandler
extends atg.svc.search.RepositoryQueryTableFormHandler

This form handler is used to populate the customers gift lists grid on the customer view page. The form handler can be customised in a number of ways. The configurable properties DoOwnerSearch, DoSiteFilterSearch and IncludeDisabledSites, control what will make up the query. By default DoOwnerSearch is set to 'true' meaning that the search query will always return results based on the owner property. DoSiteFilterSearch similarly by default is set to 'true' also meaning that given multisite being enabled the search query will only return results that have a valid site. by default gift lists with a site that has been disabled will still be returned as part of the search results 'IncludeDisabledSites' can be configured to 'false' if it is required these results be omitted.

Field Summary

static java.lang.String	CLASS_VERSION Class version string
protected CSRAgentTools	mCSRAgentTools
protected java.lang.String	mProfileId
protected java.lang.String	mSiteIdPropertyName

Fields inherited from class atg.svc.search.RepositoryQueryTableFormHandler

mItemDescriptorName, mRepository, mRepositoryView

Fields inherited from class atg.svc.search.PagingTableFormHandler

mCurrentPage, mResultsPerPage, mSearchResults, mSortDirection, mSortField, mTotalItemCount, SORT_DIRECTION_ASCENDING, SORT_DIRECTION_DESCENDING

Fields inherited from class atg.svc.ui.formhandlers.ServiceFormHandler

PERFMON_OP_FORM_HANDLER

Fields inherited from class atg.web.formhandlers.ApplicationFormHandler

EQUALS, PARAM_DELIMITER, QUERY_DELIMITER, STATUS_ERROR_REDIRECT, STATUS_ERROR_STAY, STATUS_SUCCESS

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.svc.ui.formhandlers.FormHandlerConstants

OPTIONS_ANSWER_DISPLAY, OPTIONS_ANSWER_DISPLAY_CURRENT_WINDOW, OPTIONS_ANSWER_DISPLAY_MULTIPLE_WINDOWS, OPTIONS_ANSWER_DISPLAY_SINGLE_WINDOW, OPTIONS_FILTER_BY_DOC_SET, OPTIONS_FILTER_BY_FORMAT, OPTIONS_FILTER_BY_SOURCE, OPTIONS_FILTER_BY_TITLE, OPTIONS_FILTER_OR_GROUPING_FILTER, OPTIONS_FILTER_OR_GROUPING_GROUP, OPTIONS_FILTER_OR_GROUPING_NONE, OPTIONS_QUERY_LANGUAGE, OPTIONS_RESULT_LANGUAGE, OPTIONS_SHOW_ANSWERS_AS, OPTIONS_SHOW_ANSWERS_BY_DOC, OPTIONS_SHOW_ANSWERS_INDIVIDUAL, OPTIONS_SHOW_FAQS_AS_QUESTIONS, OPTIONS_SHOW_FAQS_AS_QUESTIONS_AND_ANSWERS, PARAM_SITE_ID

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

GiftlistTableFormHandler()

Method Summary

protected atg.repository.Query	createSearchQuery(atg.repository.QueryBuilder pQueryBuilder) Return the query that should be executed on the Repository View.
protected atg.repository.Query	generateOwnerSearchQuery(atg.repository.QueryBuilder pQueryBuilder, java.lang.String pProfileId) Creates a query for finding all gift lists owned by the customer.
protected atg.repository.Query	generateSiteConstrainedQuery(atg.repository.QueryBuilder pQueryBuilder) Returns a query that represents a site search.
CSRAgentTools	getCSRAgentTools()
atg.commerce.gifts.GiftlistManager	getGiftlistManager() Returns property GiftlistManager
java.lang.String	getProfileId() returns the profile id for which the order search will be generated
java.lang.String	getSiteId(atg.repository.RepositoryItem pSite) Returns the site Id
java.lang.String	getSiteIdPropertyName() Returns the name of the site id property in the repository
atg.multisite.SiteManager	getSiteManager() Returns property SiteManager.
boolean	isDoOwnerSearch() Returns property DoOwnerSearch
boolean	isDoSiteFilterSearch() Returns property DoSiteFilterSearch
boolean	isIncludeDisabledSites() Returns property IncludeDisabledSites
void	setCSRAgentTools(CSRAgentTools pCSRAgentTools) Sets the property CSRAgentTools.
void	setDoOwnerSearch(boolean pDoOwnerSearch) Sets property DoOwnerSearch
void	setDoSiteFilterSearch(boolean pDoSiteFilterSearch) Sets property DoSiteFilterSearch
void	setGiftlistManager(atg.commerce.gifts.GiftlistManager pGiftlistManager) Sets property giftlistManager
void	setIncludeDisabledSites(boolean pIncludeDisabledSites) Sets property IncludeDisabledSites
void	setProfileId(java.lang.String pProfileId)
void	setSiteIdPropertyName(java.lang.String pSiteIdPropertyName) Sets the name of the site id property in the repository
void	setSiteManager(atg.multisite.SiteManager pSiteManager) Sets property SiteManager.

Methods inherited from class atg.svc.search.RepositoryQueryTableFormHandler

assembleSearchResults, executeCountQuery, getItemDescriptorName, getRepository, getRepositoryView, search, setItemDescriptorName, setRepository

Methods inherited from class atg.svc.search.PagingTableFormHandler

buildSortDirectives, calculateEndIndex, calculateStartIndex, getCurrentPage, getResultsPerPage, getSearchResults, getSortDirection, getSortField, getTotalItemCount, handleSearch, postSearch, preSearch, setCurrentPage, setResultsPerPage, setSearchResults, setSortDirection, setSortField, setTotalItemCount

Methods inherited from class atg.svc.ui.formhandlers.FrameworkBaseFormHandler

formHandlerInit, getErrorURL, getParameterMap, getParameters, handleChangeTab, handleCloseWindow, handleGetWindowTab, handleHidePanel, handleProcessPanel, handleScrollPanelTabsLeft, handleScrollPanelTabsRight, handleSelectTabbedPanel, handleShowPanel, handleToggleCell, handleTogglePanel, handleTogglePanelContent, handleTogglePanelsToTabs, handleTransform, setErrorURL, setParameterMap, setParameters

Methods inherited from class atg.svc.ui.formhandlers.ServiceFormHandler

handleUncheckedFormException, isLoggingUncheckedException, isRollbackTransactionOnFormError, isTransactionMarkedAsRollback, processException, processException, setLoggingUncheckedException, setRollbackTransactionOnFormError

Methods inherited from class atg.web.formhandlers.ApplicationFormHandler

addParameterToURLString, beforeGet, beforeSet, checkFormError, checkFormRedirect, checkFormSuccess, formHandlerBeforeGet, formHandlerBeforeSet, getDefaultLocale, getRedirectDelayMS, getString, getString, getString, getSuccessURL, getUserLocale, getUserMessagesResourceBundle, handleCancel, isUseRequestLocale, processException, processException, processExceptionAndLog, processExceptionAndLog, redirect, setDefaultLocale, setRedirectDelayMS, setSuccessURL, setUseRequestLocale, setUserMessagesResourceBundle

Methods inherited from class atg.droplet.TransactionalFormHandler

afterSet, commitTransaction, getTransactionDemarcation, getTransactionStatus, isEnsureTransaction, isRollbackTransaction, isRollbackTransactionOnUnhandledException, setEnsureTransaction, setRollbackTransaction, setRollbackTransactionOnUnhandledException, setTransactionDemarcation

Methods inherited from class atg.droplet.GenericFormHandler

addFormException, addUncheckedFormException, createFormSubmissionMessage, getCancelURL, getCheckForValidSession, getFormError, getFormExceptions, getFormName, getMessagePort, getMessageSource, getMessageType, getPropertyExceptions, getSendMessages, getUncheckedFormExceptions, handleFormException, 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

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

mSiteIdPropertyName

protected java.lang.String mSiteIdPropertyName

mCSRAgentTools

protected CSRAgentTools mCSRAgentTools

mProfileId

protected java.lang.String mProfileId

Constructor Detail

GiftlistTableFormHandler

public GiftlistTableFormHandler()

Method Detail

setDoOwnerSearch

public void setDoOwnerSearch(boolean pDoOwnerSearch)

Sets property DoOwnerSearch

Parameters:

pDoOwnerSearch - the property to store the boolean value of whether or not to perform search by owner.

isDoOwnerSearch

public boolean isDoOwnerSearch()

Returns property DoOwnerSearch

Returns:

The value of the property DoOwnerSearch.

setDoSiteFilterSearch

public void setDoSiteFilterSearch(boolean pDoSiteFilterSearch)

Sets property DoSiteFilterSearch

Parameters:

pDoSiteFilterSearch - the property to store the boolean value of whether or not to perform filtering by site in regards to a gift list.

isDoSiteFilterSearch

public boolean isDoSiteFilterSearch()

Returns property DoSiteFilterSearch

Returns:

The value of the property DoSiteFilterSearch.

setIncludeDisabledSites

public void setIncludeDisabledSites(boolean pIncludeDisabledSites)

Sets property IncludeDisabledSites

Parameters:

pIncludeDisabledSites - the property to store the boolean value of whether or not to display giftlists belonging to disabled sites.

isIncludeDisabledSites

public boolean isIncludeDisabledSites()

Returns property IncludeDisabledSites

Returns:

The value of the property IncludeDisabledSites.

setGiftlistManager

public void setGiftlistManager(atg.commerce.gifts.GiftlistManager pGiftlistManager)

Sets property giftlistManager

Parameters:

pGiftlistManager - gift list manager.

getGiftlistManager

public atg.commerce.gifts.GiftlistManager getGiftlistManager()

Returns property GiftlistManager

Returns:

gift list manager

setSiteManager

public void setSiteManager(atg.multisite.SiteManager pSiteManager)

Sets property SiteManager.

Parameters:

pSiteManager - the SiteManager

getSiteManager

public atg.multisite.SiteManager getSiteManager()

Returns property SiteManager. return property SiteManager.

getSiteIdPropertyName

public java.lang.String getSiteIdPropertyName()

Returns the name of the site id property in the repository

setSiteIdPropertyName

public void setSiteIdPropertyName(java.lang.String pSiteIdPropertyName)

Sets the name of the site id property in the repository

setCSRAgentTools

public void setCSRAgentTools(CSRAgentTools pCSRAgentTools)

Sets the property CSRAgentTools.

getCSRAgentTools

public CSRAgentTools getCSRAgentTools()

Returns:

The value of the property CSRAgentTools.

getProfileId

public java.lang.String getProfileId()

returns the profile id for which the order search will be generated

Returns:

String

setProfileId

public void setProfileId(java.lang.String pProfileId)

getSiteId

public java.lang.String getSiteId(atg.repository.RepositoryItem pSite)

Returns the site Id

Parameters:

pSite -

Returns:

boolean

generateSiteConstrainedQuery

protected atg.repository.Query generateSiteConstrainedQuery(atg.repository.QueryBuilder pQueryBuilder)
                                                     throws atg.repository.RepositoryException

Returns a query that represents a site search. This method will filter out deleted sites and optionaly filter out disabled sites. If no sites are found a query for site Id against null is returned.

Parameters:

pQueryBuilder - the builder that should be used to construct the query

Returns:

query

Throws:

atg.repository.RepositoryException

generateOwnerSearchQuery

protected atg.repository.Query generateOwnerSearchQuery(atg.repository.QueryBuilder pQueryBuilder,
                                                        java.lang.String pProfileId)
                                                 throws atg.repository.RepositoryException

Creates a query for finding all gift lists owned by the customer.

Parameters:

pQueryBuilder -

pProfileId -

Returns:

Query for gift list items

Throws:

atg.repository.RepositoryException

createSearchQuery

protected atg.repository.Query createSearchQuery(atg.repository.QueryBuilder pQueryBuilder)
                                          throws atg.repository.RepositoryException

Return the query that should be executed on the Repository View. This method attempts to build its query from owner and site search subqueries. It calls each sub method to build the sub query. The method attempts to build an AND query between search queries.

Specified by:

createSearchQuery in class atg.svc.search.RepositoryQueryTableFormHandler

Parameters:

pQueryBuilder - the builder that should be used to construct the query

Throws:

atg.repository.RepositoryException - if an error occured while forming the query