atg.commerce.csr.approvals.appeasement

Class AppeasementApprovalFormHandler

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.droplet.EmptyFormHandler

atg.droplet.GenericFormHandler

atg.svc.agent.environment.EnvironmentChangeFormHandler

atg.commerce.csr.approvals.AgentApprovalFormHandler

atg.commerce.csr.approvals.appeasement.AppeasementApprovalFormHandler

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

public class AppeasementApprovalFormHandler
extends atg.commerce.csr.approvals.AgentApprovalFormHandler

This form handler is used to execute the approval process for an Order Approval.

It also integrates an update of the agent's environment with the approval process. To complete the approval, the Approval's customer profile and ticket are loaded into global context.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string
protected atg.commerce.csr.approvals.appeasement.AppeasementApprovalTools	mAppeasementApprovalTools Sets the confirmation info component used to send emails
protected atg.commerce.csr.order.appeasement.AppeasementManager	mAppeasementManager
protected java.lang.String	mApprovalId
protected ConfirmationInfo	mConfirmationInfo

Fields inherited from class atg.commerce.csr.approvals.AgentApprovalFormHandler

INPUT_PARAM_APPROVAL, INPUT_PARAM_APPROVAL_ID, LOCK_NAME_ATTRIBUTE_NAME, mApprovalsManager, mAutoSendApprovalAcceptedEmail, mAutoSendApprovalRejectedEmail, mCSRAgentTools, mCustomerEmail, mCustomerProfileIdParameterName, mEnsureTransaction, mProfile, PARAM_TRANSACTION_CREATED, PARAM_VALUE_TRUE

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

Method Summary

Modifier and Type	Method and Description
protected boolean	approve(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Executes the changeEnvironment method to complete the environment change process.
atg.commerce.csr.approvals.appeasement.AppeasementApprovalTools	getAppeasementApprovalTools() Returns the appeasement approval tools
atg.commerce.csr.order.appeasement.AppeasementManager	getAppeasementManager() Returns the AppeasementManager object
protected boolean	initializeConfirmationInfoForApprove(Approval pApproval) Initializes the confirmation info object when an order is approved
protected boolean	initializeConfirmationInfoForReject(Approval pApproval) Initializes the confirmation info object when an order is rejected
protected boolean	postApprove(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) If there are no errors, adds a success message to the message bar.
protected boolean	postReject(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) If there are no errors, adds a rejection success message to the message bar.
protected boolean	preApprove(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Performed before the approve() method.
protected boolean	preReject(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Dummy method to be called before reject is called - to be over-ridden
protected boolean	reject(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Executes the changeEnvironment method to complete the environment change process.
void	setAppeasementApprovalTools(atg.commerce.csr.approvals.appeasement.AppeasementApprovalTools pAppeasementApprovalTools) Sets the order approval tools
void	setAppeasementManager(atg.commerce.csr.order.appeasement.AppeasementManager pAppeasementManager) Sets the AppeasementManager object
protected void	setupInputParameters(java.util.Map pInputParameters, atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Extended to load the approval object based on the id and determine the environment objects: customer profile and ticket, that should be loaded into global context before the approval is executed.

Methods inherited from class atg.commerce.csr.approvals.AgentApprovalFormHandler

acquireTransactionLock, afterSet, beforeSet, commitTransaction, ensureTransaction, getApprovalId, getApprovalsManager, getAutoSendApprovalAcceptedEmail, getAutoSendApprovalRejectedEmail, getConfirmationInfo, getCSRAgentTools, getCurrentTransaction, getCustomerEmail, getCustomerProfileIdParameterName, getProfile, getTransactionLockFactory, handleApprove, handleReject, isEnsureTransaction, isTransactionCreated, isTransactionMarkedAsRollBack, processException, releaseTransactionLock, setApprovalId, setApprovalsManager, setAutoSendApprovalAcceptedEmail, setAutoSendApprovalRejectedEmail, setConfirmationInfo, setCSRAgentTools, setCustomerEmail, setCustomerProfileIdParameterName, setEnsureTransaction, setProfile, setTransactionCreated, setTransactionLockFactory, unsetTransactionCreated

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

addRedirectURLParams, changeEnvironment, 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

Methods inherited from class atg.droplet.GenericFormHandler

addFormException, addUncheckedFormException, 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

mConfirmationInfo

protected ConfirmationInfo mConfirmationInfo

mAppeasementApprovalTools

protected atg.commerce.csr.approvals.appeasement.AppeasementApprovalTools mAppeasementApprovalTools

Sets the confirmation info component used to send emails

mAppeasementManager

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

mApprovalId

protected java.lang.String mApprovalId

Constructor Detail

AppeasementApprovalFormHandler

public AppeasementApprovalFormHandler()

Method Detail

setAppeasementApprovalTools

public void setAppeasementApprovalTools(atg.commerce.csr.approvals.appeasement.AppeasementApprovalTools pAppeasementApprovalTools)

Sets the order approval tools

Parameters:

pAppeasementApprovalTools - the AppeasementApprovalTools to set

getAppeasementApprovalTools

public atg.commerce.csr.approvals.appeasement.AppeasementApprovalTools getAppeasementApprovalTools()

Returns the appeasement approval tools

Returns:

the AppeasementApprovalTools

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

setupInputParameters

protected void setupInputParameters(java.util.Map pInputParameters,
                                    atg.servlet.DynamoHttpServletRequest pRequest,
                                    atg.servlet.DynamoHttpServletResponse pResponse)
                             throws atg.svc.agent.environment.EnvironmentException

Extended to load the approval object based on the id and determine the environment objects: customer profile and ticket, that should be loaded into global context before the approval is executed. These objects are added as input parameters to the environment change.

Overrides:

setupInputParameters in class atg.commerce.csr.approvals.AgentApprovalFormHandler

Parameters:

pInputParameters - - a map of input parameters

pRequest - the servlet's request

pResponse - the servlet's response

Throws:

atg.svc.agent.environment.EnvironmentException - if there was an error while executing the code

preApprove

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

Performed before the approve() method. This method sets up the environment for the appeasement approval

Overrides:

preApprove in class atg.commerce.csr.approvals.AgentApprovalFormHandler

Parameters:

pRequest - - the servlet's request

pResponse - - the servlet's response

Returns:

false if a redirect occurred

Throws:

javax.servlet.ServletException - if there was an error while executing the code

java.io.IOException - if there was an error while executing the code

preReject

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

Dummy method to be called before reject is called - to be over-ridden

Overrides:

preReject in class atg.commerce.csr.approvals.AgentApprovalFormHandler

Parameters:

pRequest - - The DynamoHttpServletRequest object parameter

pResponse - - The DynamoHttpServletResponse object parameter

Returns:

false if a redirect occurred

Throws:

javax.servlet.ServletException - if there was an error while executing the code

java.io.IOException - if there was an error with servlet io

postApprove

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

If there are no errors, adds a success message to the message bar.

Overrides:

postApprove in class atg.commerce.csr.approvals.AgentApprovalFormHandler

Parameters:

pRequest - - The DynamoHttpServletRequest object parameter

pResponse - - The DynamoHttpServletResponse object parameter

Returns:

false if a redirect occurred

Throws:

javax.servlet.ServletException - if there was an error while executing the code

java.io.IOException - if there was an error with servlet io

initializeConfirmationInfoForApprove

protected boolean initializeConfirmationInfoForApprove(Approval pApproval)

Initializes the confirmation info object when an order is approved

Overrides:

initializeConfirmationInfoForApprove in class atg.commerce.csr.approvals.AgentApprovalFormHandler

Parameters:

pApproval - - the approval to use in the confirmation message

Returns:

boolean - returns false if no customer email on the approval

initializeConfirmationInfoForReject

protected boolean initializeConfirmationInfoForReject(Approval pApproval)

Initializes the confirmation info object when an order is rejected

Overrides:

initializeConfirmationInfoForReject in class atg.commerce.csr.approvals.AgentApprovalFormHandler

Parameters:

pApproval - - the approval to use in the confirmation message

Returns:

boolean - returns false if no customer email on the approval

postReject

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

If there are no errors, adds a rejection success message to the message bar.

Overrides:

postReject in class atg.commerce.csr.approvals.AgentApprovalFormHandler

Parameters:

pRequest - - The DynamoHttpServletRequest object parameter

pResponse - - The DynamoHttpServletResponse object parameter

Returns:

false if a redirect occurred

Throws:

javax.servlet.ServletException - if there was an error while executing the code

java.io.IOException - if there was an error with servlet io

approve

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

Executes the changeEnvironment method to complete the environment change process. After which, the ApprovalsManager is called to execute the approval process.

Overrides:

approve in class atg.commerce.csr.approvals.AgentApprovalFormHandler

Parameters:

pRequest - the servlet's request

pResponse - the servlet's response

Returns:

false if a redirect occurred

Throws:

javax.servlet.ServletException - if there was an error while executing the code

java.io.IOException - if there was an error with servlet io

reject

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

Executes the changeEnvironment method to complete the environment change process. After which, the ApprovalsManager is called to execute the rejection process.

Overrides:

reject in class atg.commerce.csr.approvals.AgentApprovalFormHandler

Parameters:

pRequest - the servlet's request

pResponse - the servlet's response

Returns:

false if a redirect occurred

Throws:

javax.servlet.ServletException - if there was an error while executing the code

java.io.IOException - if there was an error with servlet io