atg.commerce.csr.order

Class RelatedOrdersTableFormHandler

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.order.OrderTableFormHandler

atg.commerce.csr.order.RelatedOrdersTableFormHandler

All Implemented Interfaces:

atg.core.logging.Logging, atg.core.logging.TraceLogging, 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 RelatedOrdersTableFormHandler
extends OrderTableFormHandler

This form handler is used to generate the list orders displayed in the exchange order panel on the order view.

Nested Class Summary

Nested classes/interfaces inherited from class atg.commerce.csr.order.OrderTableFormHandler

OrderTableFormHandler.ResultWrapper

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION
protected java.lang.String	mOrderId

Fields inherited from class atg.commerce.csr.order.OrderTableFormHandler

mCatalogTools, mCSRAgentTools, mProfileId

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

Constructors

Constructor and Description
RelatedOrdersTableFormHandler()

Method Summary

Modifier and Type	Method and Description
protected atg.repository.Query	createSearchQuery(atg.repository.QueryBuilder pQueryBuilder) Generates a query for all exchange orders or parent orders.
java.lang.String	getOrderId() The id of the templte order for which to find the submitted orders
atg.commerce.csr.returns.ReturnTools	getReturnTools() Returns the return tools
boolean	isIncludeSearchByReplacementOrder() Determines if the search also includes orders that are the parent of the order.
void	setIncludeSearchByReplacementOrder(boolean pIncludeSearchByReplacementOrder)
void	setOrderId(java.lang.String pOrderId)
void	setReturnTools(atg.commerce.csr.returns.ReturnTools pReturnTools) sets the return tools

Methods inherited from class atg.commerce.csr.order.OrderTableFormHandler

assembleSearchResults, createOrdersByUserQuery, createSearchQuery, getCatalogTools, getCSRAgentTools, getFirstOrderItemName, getProfileId, isNullValue, setCatalogTools, setCSRAgentTools, setProfileId

Methods inherited from class atg.svc.search.RepositoryQueryTableFormHandler

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, clearAbsoluteNameAndContext, createAdminServlet, doStartService, doStopService, getAbsoluteName, getAdminServlet, getAdminServletOutputStreamEncoding, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isAdminServletUseServletOutputStream, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, isStartServiceComplete, 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, toString

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

Field Detail

CLASS_VERSION

public static final java.lang.String CLASS_VERSION

See Also:

Constant Field Values

mOrderId

protected java.lang.String mOrderId

Constructor Detail

RelatedOrdersTableFormHandler

public RelatedOrdersTableFormHandler()

Method Detail

setReturnTools

public void setReturnTools(atg.commerce.csr.returns.ReturnTools pReturnTools)

sets the return tools

Parameters:

pReturnTools - the return tools

getReturnTools

public atg.commerce.csr.returns.ReturnTools getReturnTools()

Returns the return tools

isIncludeSearchByReplacementOrder

public boolean isIncludeSearchByReplacementOrder()

Determines if the search also includes orders that are the parent of the order. (e.g. if this order is an exchange order created from another order)

default is true

Returns:

setIncludeSearchByReplacementOrder

public void setIncludeSearchByReplacementOrder(boolean pIncludeSearchByReplacementOrder)

getOrderId

public java.lang.String getOrderId()

The id of the templte order for which to find the submitted orders

Returns:

setOrderId

public void setOrderId(java.lang.String pOrderId)

createSearchQuery

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

Generates a query for all exchange orders or parent orders.

Overrides:

createSearchQuery in class OrderTableFormHandler

Throws:

atg.repository.RepositoryException

See Also:

OrderTableFormHandler.createOrdersByUserQuery(QueryBuilder, String)