atg.commerce.csr.approvals.order

Class OrderApprovalFormHandler

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

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 OrderApprovalFormHandler
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 OrderApprovalTools	mOrderApprovalTools

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

INPUT_PARAM_APPROVAL, INPUT_PARAM_APPROVAL_ID, LOCK_NAME_ATTRIBUTE_NAME, mApprovalId, mApprovalsManager, mAutoSendApprovalAcceptedEmail, mAutoSendApprovalRejectedEmail, mConfirmationInfo, 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
OrderApprovalFormHandler()

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.
boolean	getAutoSendApprovalRejectedEmail() Returns the auto send approval rejected email configuration
OrderApprovalTools	getOrderApprovalTools() Returns the order approval tools
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) Performed before the reject() method.
protected boolean	reject(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Executes the changeEnvironment method to complete the environment change process.
void	setOrderApprovalTools(OrderApprovalTools pOrderApprovalTools) Sets the order approval tools
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, 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, 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, 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

mOrderApprovalTools

protected OrderApprovalTools mOrderApprovalTools

Constructor Detail

OrderApprovalFormHandler

public OrderApprovalFormHandler()

Method Detail

setOrderApprovalTools

public void setOrderApprovalTools(OrderApprovalTools pOrderApprovalTools)

Sets the order approval tools

Parameters:

pOrderApprovalTools - the OrderApprovalTools to set

getOrderApprovalTools

public OrderApprovalTools getOrderApprovalTools()

Returns the order approval tools

Returns:

the OrderApprovalTools

getAutoSendApprovalRejectedEmail

public boolean getAutoSendApprovalRejectedEmail()

Returns the auto send approval rejected email configuration

Overrides:

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

Returns:

the mAutoSendApprovalRejectedEmail

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 -

pResponse -

Throws:

atg.svc.agent.environment.EnvironmentException

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 and changes the order state to INCOMPLETE prior to being approved

Overrides:

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

Parameters:

pRequest -

pResponse -

Returns:

false if a redirect occurred

Throws:

javax.servlet.ServletException

java.io.IOException

preReject

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

Performed before the reject() method. This method sets up the environment and changes the order state to INCOMPLETE prior to being rejected

Overrides:

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

Parameters:

pRequest -

pResponse -

Returns:

false if a redirect occurred

Throws:

javax.servlet.ServletException

java.io.IOException

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 -

pResponse -

Returns:

false if a redirect occurred

Throws:

javax.servlet.ServletException

java.io.IOException

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 -

pResponse -

Returns:

false if a redirect occurred

Throws:

javax.servlet.ServletException

java.io.IOException

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 -

pResponse -

Returns:

false if a redirect occurred

Throws:

javax.servlet.ServletException

java.io.IOException

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 -

pResponse -

Returns:

false if a redirect occurred

Throws:

javax.servlet.ServletException

java.io.IOException