atg.commerce.csr.order.appeasement

Class StartAppeasementFormHandler

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.droplet.EmptyFormHandler

atg.droplet.GenericFormHandler

atg.svc.agent.environment.EnvironmentChangeFormHandler

atg.commerce.csr.order.appeasement.StartAppeasementFormHandler

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 StartAppeasementFormHandler
extends atg.svc.agent.environment.EnvironmentChangeFormHandler
implements atg.commerce.util.PipelineErrorHandler

The StartAppeasementFormHandler is used to provide support for initiating the appeasement process flow. It calls into AppeasementManager.createAppeasement to kick off the createAppeasement pipeline chain.

This method also checks if there is any pending appeasement for the selected order and if there is any ,initiating a new appeasement is prevented.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string
protected atg.commerce.csr.order.appeasement.AppeasementManager	mAppeasementManager
protected CSRAgentTools	mCSRAgentTools
protected static java.lang.String	RESOURCE_NAME Resource Bundle
protected static java.util.ResourceBundle	sResourceBundle

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
StartAppeasementFormHandler()

Method Summary

Modifier and Type	Method and Description
protected boolean	changeEnvironment(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) This method initializes the appeasement process after ensuring the order has been loaded.
protected java.util.Map<java.lang.Object,java.lang.Object>	generateAppeasementParams() Generates the extra parameter Map that is passed to the create appeasement pipeline.
atg.commerce.csr.order.appeasement.AppeasementManager	getAppeasementManager() Returns the AppeasementManager object
CSRAgentTools	getCSRAgentTools() Returns the CSRAgentTools object
void	handlePipelineError(java.lang.Object pError, java.lang.String pErrorKey) Add a pipeline error to the list of form exceptions.
void	setAppeasementManager(atg.commerce.csr.order.appeasement.AppeasementManager pAppeasementManager) Sets the AppeasementManager object
void	setCSRAgentTools(CSRAgentTools pCSRAgentTools) Sets the CSRAgentTools property

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, 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 java.lang.String CLASS_VERSION

Class version string

RESOURCE_NAME

protected static final java.lang.String RESOURCE_NAME

Resource Bundle

See Also:

Constant Field Values

sResourceBundle

protected static java.util.ResourceBundle sResourceBundle

mCSRAgentTools

protected CSRAgentTools mCSRAgentTools

mAppeasementManager

protected atg.commerce.csr.order.appeasement.AppeasementManager mAppeasementManager

Constructor Detail

StartAppeasementFormHandler

public StartAppeasementFormHandler()

Method Detail

setCSRAgentTools

public void setCSRAgentTools(CSRAgentTools pCSRAgentTools)

Sets the CSRAgentTools property

Parameters:

pCSRAgentTools - the CSRAgentTools property

getCSRAgentTools

public CSRAgentTools getCSRAgentTools()

Returns the CSRAgentTools object

Returns:

the CSRAgentTools object

setAppeasementManager

public void setAppeasementManager(atg.commerce.csr.order.appeasement.AppeasementManager pAppeasementManager)

Sets the AppeasementManager object

Parameters:

pAppeasementManager - the AppeasementManager object

getAppeasementManager

public atg.commerce.csr.order.appeasement.AppeasementManager getAppeasementManager()

Returns the AppeasementManager object

Returns:

the AppeasementManager object

changeEnvironment

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

This method initializes the appeasement process after ensuring the order has been loaded.

This method also checks if there is any pending appeasement for the selected order and if there is any ,initiating a new appeasement is prevented.

Overrides:

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

Throws:

javax.servlet.ServletException

java.io.IOException

See Also:

AppeasementManager#initiateAppeasement(String, Map), AppeasementManager.checkForPendingAppeasement(String), EnvironmentChangeFormHandler.changeEnvironment(DynamoHttpServletRequest, DynamoHttpServletResponse)

generateAppeasementParams

protected java.util.Map<java.lang.Object,java.lang.Object> generateAppeasementParams()

Generates the extra parameter Map that is passed to the create appeasement pipeline.

Returns:

Returns a map of extra parameters

handlePipelineError

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

Add a pipeline error to the list of form exceptions.

Specified by:

handlePipelineError in interface atg.commerce.util.PipelineErrorHandler

Parameters:

pError - the error reported by the pipeline.

pErrorKey - the key of the error, used for localization.