atg.commerce.csr.returns

Class StartReturnExchangeProcess

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.droplet.EmptyFormHandler

atg.droplet.GenericFormHandler

atg.svc.agent.environment.EnvironmentChangeFormHandler

atg.commerce.csr.returns.StartReturnExchangeProcess

All Implemented Interfaces:

atg.commerce.util.PipelineErrorHandler, 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, java.util.EventListener

public class StartReturnExchangeProcess
extends atg.svc.agent.environment.EnvironmentChangeFormHandler
implements atg.commerce.util.PipelineErrorHandler

This form handler is used to start the return and exchange process. It will first load the order into global context.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string
protected CSRAgentTools	mCSRAgentTools
protected java.util.Map	mProgressBarItems
protected atg.commerce.csr.returns.ReturnManager	mReturnManager

Fields inherited from class atg.svc.agent.environment.EnvironmentChangeFormHandler

AGENTRESOURCES, AGENTUSERRESOURCES, mApplicationName, mDoTicketDispositionPrompt, mDoWarnings, mEnvironmentChangeKey, mEnvironmentChangeState, mEnvironmentTools, mInitChangeState, mInputParameters, mMessageTools, mTicketDispositionChangeHandler, mTicketDispositionOptions, mTicketingTools, mTransactionManager, sBundle

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

Constructors

Constructor and Description
StartReturnExchangeProcess()

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	changeEnvironment(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Initializes the return request after ensuring the order has been loaded.
protected java.util.Map	generateCreateReturnRequestParams() Generates the extra pararmeter Map that is passed to the create retrun pipeline
CSRAgentTools	getCSRAgentTools() Returns the cSRAgentTools.
java.util.Map	getProgressBarItems() Returns the progressBarItems.
atg.commerce.csr.returns.ReturnManager	getReturnManager() Returns the return manager object
void	handlePipelineError(java.lang.Object pError, java.lang.String pErrorKey)
void	processException(java.lang.Exception pException, java.lang.String pMsgId, atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Add a user error message to the form exceptions, and then display the exception in the logs
void	setCSRAgentTools(CSRAgentTools pAgentTools) Sets the cSRAgentTools.
void	setProgressBarItems(java.util.Map pProgressBarItems) Sets the progressBarItems.
void	setReturnManager(atg.commerce.csr.returns.ReturnManager pReturnManager) sets the return manager object

Methods inherited from class atg.svc.agent.environment.EnvironmentChangeFormHandler

addRedirectURLParams, conformRedirectURL, getApplicationName, getConfirmPromptURL, getConfirmURL, getEnvironmentChangeKey, getEnvironmentChangeState, getEnvironmentTools, getErrorURL, getInputParameters, getMessageTools, getSuccessURL, getTicketDispositionChangeHandler, getTicketDispositionOptions, getTicketingTools, getTransactionManager, getUserLocale, getUserMessage, getUserMessage, handleChangeEnvironment, initChangeState, initChangeState, isDoTicketDispositionPrompt, isDoWarnings, isInitChangeState, isShowDispositionPrompt, postChangeEnvironment, preChangeEnvironment, setApplicationName, setConfirmPromptURL, setConfirmURL, setDoTicketDispositionPrompt, setDoWarnings, setEnvironmentChangeKey, setEnvironmentChangeState, setEnvironmentTools, setErrorURL, setInitChangeState, setInputParameters, setMessageTools, setSuccessURL, setTicketDispositionChangeHandler, setTicketDispositionOptions, setTicketingTools, setTransactionManager, setupInputParameters

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

mCSRAgentTools

protected CSRAgentTools mCSRAgentTools

mReturnManager

protected atg.commerce.csr.returns.ReturnManager mReturnManager

mProgressBarItems

protected java.util.Map mProgressBarItems

Constructor Detail

StartReturnExchangeProcess

public StartReturnExchangeProcess()

Method Detail

getCSRAgentTools

public CSRAgentTools getCSRAgentTools()

Returns the cSRAgentTools.

Returns:

cSRAgentTools

setCSRAgentTools

public void setCSRAgentTools(CSRAgentTools pAgentTools)

Sets the cSRAgentTools.

Parameters:

pAgentTools -

setReturnManager

public void setReturnManager(atg.commerce.csr.returns.ReturnManager pReturnManager)

sets the return manager object

Parameters:

pReturnManager - the return manager

getProgressBarItems

public java.util.Map getProgressBarItems()

Returns the progressBarItems.

Returns:

progressBarItems

setProgressBarItems

public void setProgressBarItems(java.util.Map pProgressBarItems)

Sets the progressBarItems.

Parameters:

pProgressBarItems -

getReturnManager

public atg.commerce.csr.returns.ReturnManager getReturnManager()

Returns the return manager object

changeEnvironment

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

Initializes the return request after ensuring the order has been loaded.

Overrides:

changeEnvironment in class atg.svc.agent.environment.EnvironmentChangeFormHandler

Throws:

javax.servlet.ServletException

java.io.IOException

See Also:

ReturnManager.createReturnRequest(String, ProcessName, Map)

generateCreateReturnRequestParams

protected java.util.Map generateCreateReturnRequestParams()

Generates the extra pararmeter Map that is passed to the create retrun pipeline

Returns:

Map of extra parameters

handlePipelineError

public void handlePipelineError(java.lang.Object pError,
                       java.lang.String pErrorKey)

Specified by:

handlePipelineError in interface atg.commerce.util.PipelineErrorHandler

processException

public void processException(java.lang.Exception pException,
                    java.lang.String pMsgId,
                    atg.servlet.DynamoHttpServletRequest pRequest,
                    atg.servlet.DynamoHttpServletResponse pResponse)
                      throws javax.servlet.ServletException,
                             java.io.IOException

Add a user error message to the form exceptions, and then display the exception in the logs

Parameters:

pException - an Exception value

pMsgId - a String value

pRequest - a DynamoHttpServletRequest value

pResponse - a DynamoHttpServletResponse value

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs