atg.commerce.csr.order
Class RelatedTicketsTableFormHandler

java.lang.Object
  extended by atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      extended by atg.nucleus.GenericService
          extended by atg.droplet.EmptyFormHandler
              extended by atg.droplet.GenericFormHandler
                  extended by atg.droplet.TransactionalFormHandler
                      extended by atg.web.formhandlers.ApplicationFormHandler
                          extended by atg.svc.ui.formhandlers.ServiceFormHandler
                              extended by atg.svc.ui.formhandlers.FrameworkBaseFormHandler
                                  extended by atg.svc.search.PagingTableFormHandler
                                      extended by atg.svc.search.RepositoryQueryTableFormHandler
                                          extended by atg.commerce.csr.order.RelatedTicketsTableFormHandler
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, atg.svc.ui.formhandlers.FormHandlerConstants, java.util.EventListener

public class RelatedTicketsTableFormHandler
extends atg.svc.search.RepositoryQueryTableFormHandler

This form handler is used to produce the list of related tickets that appears on the order view's related tickets panel.


Field Summary
static java.lang.String CLASS_VERSION
          Class version string
protected  CSRAgentTools mCSRAgentTools
           
protected  atg.repository.RepositoryItem mOrderItem
           
protected  java.lang.String mOrderItemId
           
 
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
RelatedTicketsTableFormHandler()
           
 
Method Summary
protected  atg.repository.Query createSearchQuery(atg.repository.QueryBuilder pQueryBuilder)
          Creates a query for all tickets that have the order item returned by getOrderItem in the orders property
 CSRAgentTools getCSRAgentTools()
           
 atg.repository.RepositoryItem getOrderItem()
          Returns the repository item identified by the orderItemId property
 java.lang.String getOrderItemId()
          The id of the order for which to find the related tickets
 void setCSRAgentTools(CSRAgentTools pCSRAgentTools)
          Sets the property CSRAgentTools.
 void setOrderItem(atg.repository.RepositoryItem pOrderItem)
           
 void setOrderItemId(java.lang.String pOrderItemId)
           
 
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


mOrderItemId

protected java.lang.String mOrderItemId

mOrderItem

protected atg.repository.RepositoryItem mOrderItem

mCSRAgentTools

protected CSRAgentTools mCSRAgentTools
Constructor Detail

RelatedTicketsTableFormHandler

public RelatedTicketsTableFormHandler()
Method Detail

getOrderItemId

public java.lang.String getOrderItemId()
The id of the order for which to find the related tickets

Returns:

setOrderItemId

public void setOrderItemId(java.lang.String pOrderItemId)

getOrderItem

public atg.repository.RepositoryItem getOrderItem()
Returns the repository item identified by the orderItemId property

Returns:

setOrderItem

public void setOrderItem(atg.repository.RepositoryItem pOrderItem)

setCSRAgentTools

public void setCSRAgentTools(CSRAgentTools pCSRAgentTools)
Sets the property CSRAgentTools.


getCSRAgentTools

public CSRAgentTools getCSRAgentTools()
Returns:
The value of the property CSRAgentTools.

createSearchQuery

protected atg.repository.Query createSearchQuery(atg.repository.QueryBuilder pQueryBuilder)
                                          throws atg.repository.RepositoryException
Creates a query for all tickets that have the order item returned by getOrderItem in the orders property

Specified by:
createSearchQuery in class atg.svc.search.RepositoryQueryTableFormHandler
Throws:
atg.repository.RepositoryException