atg.commerce.csr.order.appeasement

Class AppeasementFormHandler

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.droplet.EmptyFormHandler

atg.droplet.GenericFormHandler

atg.commerce.order.purchase.PurchaseProcessFormHandler

atg.commerce.csr.order.appeasement.AppeasementFormHandler

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 AppeasementFormHandler
extends atg.commerce.order.purchase.PurchaseProcessFormHandler

The AppeasementFormHandler is used to provide support for adding an appeasement on a fulfilled order. It calls into AppeasementManager.submitAppeasement to kick off the submitAppeasement pipeline chain.If the submitAppeasement pipeline chain succeeds, then based on the agent's appeasement limit either the approveAppeasement chain or the processAppeasement chain will be invoked.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	APPEASEMENT_AMOUNT
static java.lang.String	APPEASEMENT_ID
static java.lang.String	APPEASEMENT_PARAM_NAME
static java.lang.String	APPEASEMENT_REASON_CODE
static java.lang.String	APPEASEMENT_TYPE
static java.lang.String	CLASS_VERSION
protected atg.userprofiling.Profile	mAgentProfile
protected atg.commerce.csr.appeasement.Appeasement	mAppeasement
protected atg.commerce.csr.order.appeasement.AppeasementManager	mAppeasementManager
protected java.lang.String	mApplyAppeasementErrorURL
protected java.lang.String	mApplyAppeasementSuccessURL
protected boolean	mAutoSendEmail
protected java.lang.String	mCancelAppeasementErrorURL
protected java.lang.String	mCancelAppeasementSuccessURL
protected ConfirmationInfo	mConfirmationInfo
protected java.lang.String	mCreateAppeasementErrorURL
protected java.lang.String	mCreateAppeasementSuccessURL
protected CSRAgentTools	mCSRAgentTools
protected java.lang.String	mOverrideEmailAddress
protected boolean	mPercentageOffAmount
protected java.lang.String	mRefundTypePropertyName
protected java.lang.String	mSendConfirmationMessageErrorURL
protected java.lang.String	mSendConfirmationMessageSuccessURL
protected java.util.List<atg.commerce.order.Refund>	mSortedRefundList
protected java.lang.String	mSubmitAppeasementErrorURL
protected java.lang.String	mSubmitAppeasementSuccessURL
protected javax.transaction.TransactionManager	mTransactionManager
protected java.lang.String	mValidateAppeasementValuesErrorURL
protected java.lang.String	mValidateAppeasementValuesSuccessURL

Fields inherited from class atg.commerce.order.purchase.PurchaseProcessFormHandler

LOCK_NAME_ATTRIBUTE_NAME, PARAM_TRANSACTION_CREATED, PARAM_VALUE_TRUE

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

Method Summary

Methods

Modifier and Type	Method and Description
void	applyAppeasementRefunds(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) This method calls AppeasementManager.applyRefundAmounts to initialize the appeasement refund amounts order.
void	cancelAppeasement(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) This method cancels the active process of appeasement creation.
atg.userprofiling.Profile	getAgentProfile() Returns the profile of the agent working on the appeasement
atg.commerce.csr.appeasement.Appeasement	getAppeasement() Returns the Appeasement object.The OrderHolder holds the appeasement object as a handle to the appeasement for a given order.
atg.commerce.csr.order.appeasement.AppeasementManager	getAppeasementManager() Returns the AppeasementManager object
java.lang.String	getApplyAppeasementErrorURL() Returns the error url property for applying the appeasement properties
java.lang.String	getApplyAppeasementSuccessURL() Returns the property to store the success url for applying the appeasement properties
java.lang.String	getCancelAppeasementErrorURL() Returns the property to store the error url for appeasement cancellation.
java.lang.String	getCancelAppeasementSuccessURL() Returns the property to store the success url for appeasement cancellation.
ConfirmationInfo	getConfirmationInfo() Returns the confirmation info object used for sending email confirmation
java.lang.String	getCreateAppeasementErrorURL() Returns the property to store the error url for appeasement creation
java.lang.String	getCreateAppeasementSuccessURL() Returns the property to store the success url for appeasement creation
CSRAgentTools	getCSRAgentTools() Returns the CSRAgentTools object
java.lang.String	getOverrideEmailAddress() Returns the string representing the email address of the to send an email confirmation to, this will override the default send address for the customer
double	getPercentageAppeasementAmount() Returns the appeasement amount calculated from the percentage value of appeasement amount to the available balance
java.util.List<atg.repository.RepositoryItem>	getReasonCodes() Retrieves a list of appeasement reason codes
java.lang.String	getRefundTypePropertyName() Returns the property to hold the type of the refund option.For example, creditCard,storeCredit
java.lang.String	getSendConfirmationMessageErrorURL() Returns the error url property for sending the appeasement confirmation message
java.lang.String	getSendConfirmationMessageSuccessURL() Returns the property to store the success url for sending the appeasement confirmation message
java.util.List<atg.commerce.order.Refund>	getSortedRefundList() This method takes the #getAppeasement().getRefundList() and sorts the refund option based on "refundType" property.
java.lang.String	getSubmitAppeasementErrorURL() Returns the error url property for submitting the appeasement
java.lang.String	getSubmitAppeasementSuccessURL() Returns the property to store the success url for submitting the appeasement
javax.transaction.TransactionManager	getTransactionManager() Returns the TransactionManager object
java.lang.String	getValidateAppeasementValuesErrorURL() Returns the error url property for continuing the appeasement properties
java.lang.String	getValidateAppeasementValuesSuccessURL() Returns the property to store the success url for continue the appeasement properties
boolean	handleApplyAppeasementRefunds(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) This method calls AppeasementManager.applyRefundAmounts to generate a list of payment groups which were part of the original order.
boolean	handleCancelAppeasement(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) This method cancels the active process of appeasement creation
boolean	handleSendConfirmationMessage(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Sends a confirmation email message regarding the new appeasement indicating whether it is successfully processed or is waiting for the approval
boolean	handleSubmitAppeasement(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) This method calls AppeasementManager.submitAppeasement to submit the current appeasement being processed
boolean	handleValidateAppeasementValues(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) This method is called to handle moving from the appeasement amount entry to the appeasement amount summary.
protected ConfirmationInfo	initializeConfirmationInfo(atg.commerce.csr.appeasement.Appeasement pAppeasement) Initializes the confirmation info object for an appeasement
boolean	isAutoSendEmail() Gets the autoSendEmail property to check if the confirmation mail has to be sent automatically or not
boolean	isPercentageOffAmount() Returns the property to hold the percentage value of appeasement amount to the available balance
void	postApplyAppeasementRefunds(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) This method is called after all processing is done by the handleApplyAppeasementRefunds method.
void	postCancelAppeasement(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) This method is called after all processing is done by the handleCancelAppeasement method.
void	postSendConfirmationMessage(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) This method is called after all processing is done by the handleSendConfirmationMessage method.
void	postSubmitAppeasement(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) This method is called after all processing is done by the handleSubmitAppeasement method.
void	postValidateAppeasementValues(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) This method is called after all processing is done by the handleValidateAppeasementValues method.
void	preApplyAppeasementRefunds(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) This method is called before any processing is done by the handleApplyAppeasementRefunds method.
void	preCancelAppeasement(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) This method is called before any processing is done by the handleCancelAppeasement method.
void	preSendConfirmationMessage(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) This method is called before any processing is done by the handleSendConfirmationMessage method.
void	preSubmitAppeasement(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) This method is called before any processing is done by the handleSubmitAppeasement method.
void	preValidateAppeasementValues(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) This method is called before any processing is done by the handleValidateAppeasementValues method.
void	sendConfirmationMessage(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Send the appeasement confirmation message using the the CSRAgentTools component
void	setAgentProfile(atg.userprofiling.Profile pAgentProfile) Sets the profile of the agent working on the appeasement
void	setAppeasement(atg.commerce.csr.appeasement.Appeasement pAppeasement) Sets the Appeasement property.The OrderHolder holds the appeasement object as a handle to the appeasement for a given order.
void	setAppeasementManager(atg.commerce.csr.order.appeasement.AppeasementManager pAppeasementManager) Sets the AppeasementManager object.
void	setApplyAppeasementErrorURL(java.lang.String pApplyAppeasementErrorURL) Sets the property to store the error url for applying the appeasement properties
void	setApplyAppeasementSuccessURL(java.lang.String pApplyAppeasementSuccessURL) Sets the applyAppeasementSuccessURL.
void	setAutoSendEmail(boolean pAutoSendEmail) Sets the autoSendEmail property to check if the confirmation mail has to be sent automatically or not
void	setCancelAppeasementErrorURL(java.lang.String pCancelAppeasementErrorURL) Sets the property to store the error url for appeasement cancellation.
void	setCancelAppeasementSuccessURL(java.lang.String pCancelAppeasementSuccessURL) Sets the property to store the success url for cancelling an appeasement
void	setConfirmationInfo(ConfirmationInfo pConfirmationInfo) Sets the ConfirmationInfo property.
void	setCreateAppeasementErrorURL(java.lang.String pCreateAppeasementErrorURL) Sets the property to store the error url for appeasement creation.
void	setCreateAppeasementSuccessURL(java.lang.String pCreateAppeasementSuccessURL) Sets the the property to store the success url for appeasement creation.
void	setCSRAgentTools(CSRAgentTools pCSRAgentTools) Sets the CSRAgentTools property.
void	setOverrideEmailAddress(java.lang.String pOverrideEmailAddress) Sets the string representing the email address of the to send an email confirmation to, this will override the default send address for the customer.
void	setPercentageAppeasementAmount(double pPercentageAppeasementAmount) Sets the property to hold the appeasement amount calculated from the percentage value of appeasement amount to the available balance
void	setPercentageOffAmount(boolean pPercentageOffAmount) Sets the property to hold the percentage value of appeasement amount to the available balance
void	setRefundTypePropertyName(java.lang.String pRefundTypePropertyName) Set the property to hold the type of the refund option.
void	setSendConfirmationMessageErrorURL(java.lang.String pSendConfirmationMessageErrorURL) Sets the property to store the error url for sending the appeasement confirmation message
void	setSendConfirmationMessageSuccessURL(java.lang.String pSendConfirmationMessageSuccessURL) Sets the success url for sending the appeasement confirmation message
void	setSortedRefundList(java.util.List<atg.commerce.order.Refund> pSortedRefundList) This method sets the objects sortedRefundList - a list of refund types (ie credit card, store credit)
void	setSubmitAppeasementErrorURL(java.lang.String pSubmitAppeasementErrorURL) Sets the property to store the error url for submitting the appeasement
void	setSubmitAppeasementSuccessURL(java.lang.String pSubmitAppeasementSuccessURL) Sets the submitAppeasementSuccessURL.
void	setTransactionManager(javax.transaction.TransactionManager pTransactionManager) Sets the TransactionManager object.
void	setValidateAppeasementValuesErrorURL(java.lang.String pValidateAppeasementValuesErrorURL) Sets the property to store the error url for continuing the appeasement properties
void	setValidateAppeasementValuesSuccessURL(java.lang.String pValidateAppeasementValuesSuccessURL) Sets the validateAppeasementValuesSuccessURL.
void	submitAppeasement(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) This method calls AppeasementManager.applyRefundAmounts to initialize the appeasement refund amounts order.
void	validateAppeasementValues(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) This method validates the amounts entered, ensuring that they are valid.

Methods inherited from class atg.commerce.order.purchase.PurchaseProcessFormHandler

acquireTransactionLock, acquireTransactionLock, afterSet, beforeSet, checkFormRedirect, commitTransaction, copyConfiguration, createRepriceParameterMap, defaultLocalLockManager, defaultUserProfile, doStartService, ensureTransaction, formatUserMessage, formatUserMessage, formatUserMessage, formatUserMessage, generatePropertyPath, getClaimableManager, getCommerceIdentifierPaymentInfoContainer, getCommerceItemManager, getCommerceItemShippingInfoContainer, getCommerceProfileTools, getCommercePropertyManager, getConfiguration, getCurrentTransaction, getDefaultLocale, getGiftlistManager, getHandlingInstructionManager, getLocalLockManager, getOrder, getOrderManager, getPaymentGroupManager, getPaymentGroupMapContainer, getPipelineManager, getPriceList, getPriceListId, getPriceListManager, getProfile, getProfileRepository, getPurchaseProcessHelper, getRepeatingRequestMonitor, getRepriceOrderChainId, getResourceBundle, getResourceBundle, getResourceBundleName, getSessionExpirationURL, getShippingGroupManager, getShippingGroupMapContainer, getShoppingCart, getUserLocale, getUserLocale, getUserPricingModels, handlePipelineError, isConcurrentUpdate, isEnsureTransaction, isFormSubmission, isTransactionCreated, isTransactionMarkedAsRollBack, isUseLocksAroundTransactions, isUseRequestLocale, processException, processPipelineErrors, releaseTransactionLock, releaseTransactionLock, runProcess, runProcess, runProcess, runProcessRepriceOrder, runProcessRepriceOrder, runRepricingProcess, setClaimableManager, setCommerceIdentifierPaymentInfoContainer, setCommerceItemManager, setCommerceItemShippingInfoContainer, setCommerceProfileTools, setCommercePropertyManager, setConfiguration, setCurrentTransaction, setDefaultLocale, setEnsureTransaction, setGiftlistManager, setHandlingInstructionManager, setLocalLockManager, setOrder, setOrderManager, setPaymentGroupManager, setPaymentGroupMapContainer, setPipelineManager, setPriceListId, setPriceListManager, setProfile, setProfileRepository, setPurchaseProcessHelper, setRepeatingRequestMonitor, setRepriceOrderChainId, setSessionExpirationURL, setShippingGroupManager, setShippingGroupMapContainer, setShoppingCart, setTransactionCreated, setTransactionToRollbackOnly, setUseLocksAroundTransactions, setUseRequestLocale, setUserLocale, setUserPricingModels, transactionLockName, unsetTransactionCreated

Methods inherited from class atg.droplet.GenericFormHandler

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

See Also:

Constant Field Values

APPEASEMENT_PARAM_NAME

public static final java.lang.String APPEASEMENT_PARAM_NAME

See Also:

Constant Field Values

APPEASEMENT_ID

public static final java.lang.String APPEASEMENT_ID

See Also:

Constant Field Values

APPEASEMENT_TYPE

public static final java.lang.String APPEASEMENT_TYPE

See Also:

Constant Field Values

APPEASEMENT_AMOUNT

public static final java.lang.String APPEASEMENT_AMOUNT

See Also:

Constant Field Values

APPEASEMENT_REASON_CODE

public static final java.lang.String APPEASEMENT_REASON_CODE

See Also:

Constant Field Values

mPercentageOffAmount

protected boolean mPercentageOffAmount

mRefundTypePropertyName

protected java.lang.String mRefundTypePropertyName

mConfirmationInfo

protected ConfirmationInfo mConfirmationInfo

mOverrideEmailAddress

protected java.lang.String mOverrideEmailAddress

mAutoSendEmail

protected boolean mAutoSendEmail

mAgentProfile

protected atg.userprofiling.Profile mAgentProfile

mAppeasement

protected atg.commerce.csr.appeasement.Appeasement mAppeasement

mSortedRefundList

protected java.util.List<atg.commerce.order.Refund> mSortedRefundList

mCSRAgentTools

protected CSRAgentTools mCSRAgentTools

mAppeasementManager

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

mTransactionManager

protected javax.transaction.TransactionManager mTransactionManager

mCreateAppeasementSuccessURL

protected java.lang.String mCreateAppeasementSuccessURL

mCreateAppeasementErrorURL

protected java.lang.String mCreateAppeasementErrorURL

mApplyAppeasementSuccessURL

protected java.lang.String mApplyAppeasementSuccessURL

mApplyAppeasementErrorURL

protected java.lang.String mApplyAppeasementErrorURL

mSubmitAppeasementSuccessURL

protected java.lang.String mSubmitAppeasementSuccessURL

mSubmitAppeasementErrorURL

protected java.lang.String mSubmitAppeasementErrorURL

mValidateAppeasementValuesSuccessURL

protected java.lang.String mValidateAppeasementValuesSuccessURL

mValidateAppeasementValuesErrorURL

protected java.lang.String mValidateAppeasementValuesErrorURL

mCancelAppeasementSuccessURL

protected java.lang.String mCancelAppeasementSuccessURL

mCancelAppeasementErrorURL

protected java.lang.String mCancelAppeasementErrorURL

mSendConfirmationMessageSuccessURL

protected java.lang.String mSendConfirmationMessageSuccessURL

mSendConfirmationMessageErrorURL

protected java.lang.String mSendConfirmationMessageErrorURL

Constructor Detail

AppeasementFormHandler

public AppeasementFormHandler()

Method Detail

setPercentageOffAmount

public void setPercentageOffAmount(boolean pPercentageOffAmount)

Sets the property to hold the percentage value of appeasement amount to the available balance

Parameters:

pPercentageOffAmount - the property to hold the percentage value of appeasement amount to the available balance

isPercentageOffAmount

public boolean isPercentageOffAmount()

Returns the property to hold the percentage value of appeasement amount to the available balance

Returns:

tthe property to hold the percentage value of appeasement amount to the available balance

setPercentageAppeasementAmount

public void setPercentageAppeasementAmount(double pPercentageAppeasementAmount)

Sets the property to hold the appeasement amount calculated from the percentage value of appeasement amount to the available balance

Parameters:

pPercentageAppeasementAmount - the appeasement amount calculated from the percentage value of appeasement amount to the available balance

getPercentageAppeasementAmount

public double getPercentageAppeasementAmount()

Returns the appeasement amount calculated from the percentage value of appeasement amount to the available balance

Returns:

the appeasement amount calculated from the percentage value of appeasement amount to the available balance

setRefundTypePropertyName

public void setRefundTypePropertyName(java.lang.String pRefundTypePropertyName)

Set the property to hold the type of the refund option. For example, creditCard,storeCredit

Parameters:

pRefundTypePropertyName - the property to hold the type of the refund option

getRefundTypePropertyName

public java.lang.String getRefundTypePropertyName()

Returns the property to hold the type of the refund option.For example, creditCard,storeCredit

Returns:

the property to hold the type of the refund option

getConfirmationInfo

public ConfirmationInfo getConfirmationInfo()

Returns the confirmation info object used for sending email confirmation

Returns:

the confirmation info object used for sending email confirmation

setConfirmationInfo

public void setConfirmationInfo(ConfirmationInfo pConfirmationInfo)

Sets the ConfirmationInfo property.

Parameters:

pConfirmationInfo - the confirmation info object used for sending email confirmation

getOverrideEmailAddress

public java.lang.String getOverrideEmailAddress()

Returns the string representing the email address of the to send an email confirmation to, this will override the default send address for the customer

Returns:

An email address or null if none is defined

setOverrideEmailAddress

public void setOverrideEmailAddress(java.lang.String pOverrideEmailAddress)

Sets the string representing the email address of the to send an email confirmation to, this will override the default send address for the customer.

Parameters:

pOverrideEmailAddress - the email address

isAutoSendEmail

public boolean isAutoSendEmail()

Gets the autoSendEmail property to check if the confirmation mail has to be sent automatically or not

Returns:

true is the confirmation mail has to be sent automatically and false otherwise

setAutoSendEmail

public void setAutoSendEmail(boolean pAutoSendEmail)

Sets the autoSendEmail property to check if the confirmation mail has to be sent automatically or not

Parameters:

pAutoSendEmail - the autoSendEmail property to check if the confirmation mail has to be sent automatically or not

setAgentProfile

public void setAgentProfile(atg.userprofiling.Profile pAgentProfile)

Sets the profile of the agent working on the appeasement

Parameters:

pAgentProfile - the profile of the agent working on the appeasement

getAgentProfile

public atg.userprofiling.Profile getAgentProfile()

Returns the profile of the agent working on the appeasement

Returns:

the profile of the agent working on the appeasement

setAppeasement

public void setAppeasement(atg.commerce.csr.appeasement.Appeasement pAppeasement)

Sets the Appeasement property.The OrderHolder holds the appeasement object as a handle to the appeasement for a given order.

Parameters:

pAppeasement - the Appeasement property

getAppeasement

public atg.commerce.csr.appeasement.Appeasement getAppeasement()

Returns the Appeasement object.The OrderHolder holds the appeasement object as a handle to the appeasement for a given order.

Returns:

the appeasement object

setSortedRefundList

public void setSortedRefundList(java.util.List<atg.commerce.order.Refund> pSortedRefundList)

This method sets the objects sortedRefundList - a list of refund types (ie credit card, store credit)

Parameters:

pSortedRefundList - - a List containing refund types

getSortedRefundList

public java.util.List<atg.commerce.order.Refund> getSortedRefundList()
                                                              throws atg.commerce.CommerceException

This method takes the #getAppeasement().getRefundList() and sorts the refund option based on "refundType" property.

Returns:

the #getAppeasement().getRefundList() is sorted and returned.

Throws:

atg.commerce.CommerceException - if fails to retireve the list of refunds

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

setTransactionManager

public void setTransactionManager(javax.transaction.TransactionManager pTransactionManager)

Sets the TransactionManager object.

Overrides:

setTransactionManager in class atg.commerce.order.purchase.PurchaseProcessFormHandler

Parameters:

pTransactionManager - the TransactionManager object

getTransactionManager

public javax.transaction.TransactionManager getTransactionManager()

Returns the TransactionManager object

Overrides:

getTransactionManager in class atg.commerce.order.purchase.PurchaseProcessFormHandler

Returns:

the TransactionManager object

setCreateAppeasementSuccessURL

public void setCreateAppeasementSuccessURL(java.lang.String pCreateAppeasementSuccessURL)

Sets the the property to store the success url for appeasement creation.

Parameters:

pCreateAppeasementSuccessURL - the property to store the success url for appeasement creation

getCreateAppeasementSuccessURL

public java.lang.String getCreateAppeasementSuccessURL()

Returns the property to store the success url for appeasement creation

Returns:

a the property to store the success url for appeasement creation

setCreateAppeasementErrorURL

public void setCreateAppeasementErrorURL(java.lang.String pCreateAppeasementErrorURL)

Sets the property to store the error url for appeasement creation.

Parameters:

pCreateAppeasementErrorURL - the property to store the error url for appeasement creation

getCreateAppeasementErrorURL

public java.lang.String getCreateAppeasementErrorURL()

Returns the property to store the error url for appeasement creation

Returns:

the property to store the error url for appeasement creation

setApplyAppeasementSuccessURL

public void setApplyAppeasementSuccessURL(java.lang.String pApplyAppeasementSuccessURL)

Sets the applyAppeasementSuccessURL.

Parameters:

pApplyAppeasementSuccessURL - the property to store the success url for applying the appeasement properties

getApplyAppeasementSuccessURL

public java.lang.String getApplyAppeasementSuccessURL()

Returns the property to store the success url for applying the appeasement properties

Returns:

the property to store the success url for applying the appeasement properties

setApplyAppeasementErrorURL

public void setApplyAppeasementErrorURL(java.lang.String pApplyAppeasementErrorURL)

Sets the property to store the error url for applying the appeasement properties

Parameters:

pApplyAppeasementErrorURL - the property to store the error url for applying the appeasement properties

getApplyAppeasementErrorURL

public java.lang.String getApplyAppeasementErrorURL()

Returns the error url property for applying the appeasement properties

Returns:

the property to store the error url for applying the appeasement properties

setSubmitAppeasementSuccessURL

public void setSubmitAppeasementSuccessURL(java.lang.String pSubmitAppeasementSuccessURL)

Sets the submitAppeasementSuccessURL.

Parameters:

pSubmitAppeasementSuccessURL - the property to store the success url for submitting the appeasement

getSubmitAppeasementSuccessURL

public java.lang.String getSubmitAppeasementSuccessURL()

Returns the property to store the success url for submitting the appeasement

Returns:

the property to store the success url for submitting the appeasement

setSubmitAppeasementErrorURL

public void setSubmitAppeasementErrorURL(java.lang.String pSubmitAppeasementErrorURL)

Sets the property to store the error url for submitting the appeasement

Parameters:

pSubmitAppeasementErrorURL - the property to store the error url for submitting the appeasement

getSubmitAppeasementErrorURL

public java.lang.String getSubmitAppeasementErrorURL()

Returns the error url property for submitting the appeasement

Returns:

the property to store the error url for submitting the appeasement

setValidateAppeasementValuesSuccessURL

public void setValidateAppeasementValuesSuccessURL(java.lang.String pValidateAppeasementValuesSuccessURL)

Sets the validateAppeasementValuesSuccessURL.

Parameters:

pValidateAppeasementValuesSuccessURL - the property to store the success url for continuing the appeasement properties

getValidateAppeasementValuesSuccessURL

public java.lang.String getValidateAppeasementValuesSuccessURL()

Returns the property to store the success url for continue the appeasement properties

Returns:

the property to store the success url for validating the appeasement properties

setValidateAppeasementValuesErrorURL

public void setValidateAppeasementValuesErrorURL(java.lang.String pValidateAppeasementValuesErrorURL)

Sets the property to store the error url for continuing the appeasement properties

Parameters:

pValidateAppeasementValuesErrorURL - the property to store the error url for continuing the appeasement properties

getValidateAppeasementValuesErrorURL

public java.lang.String getValidateAppeasementValuesErrorURL()

Returns the error url property for continuing the appeasement properties

Returns:

the property to store the error url for validating the appeasement properties

setCancelAppeasementSuccessURL

public void setCancelAppeasementSuccessURL(java.lang.String pCancelAppeasementSuccessURL)

Sets the property to store the success url for cancelling an appeasement

Parameters:

pCancelAppeasementSuccessURL - the property to store the success url for cancelling an appeasement

getCancelAppeasementSuccessURL

public java.lang.String getCancelAppeasementSuccessURL()

Returns the property to store the success url for appeasement cancellation.

Returns:

the property to store the success url for appeasement cancellation

setCancelAppeasementErrorURL

public void setCancelAppeasementErrorURL(java.lang.String pCancelAppeasementErrorURL)

Sets the property to store the error url for appeasement cancellation.

Parameters:

pCancelAppeasementErrorURL - the property to store the error url for appeasement cancellation

getCancelAppeasementErrorURL

public java.lang.String getCancelAppeasementErrorURL()

Returns the property to store the error url for appeasement cancellation.

Returns:

the property to store the error url for appeasement cancellation

setSendConfirmationMessageSuccessURL

public void setSendConfirmationMessageSuccessURL(java.lang.String pSendConfirmationMessageSuccessURL)

Sets the success url for sending the appeasement confirmation message

Parameters:

pSendConfirmationMessageSuccessURL - the property to store the success url for sending the appeasement confirmation message

getSendConfirmationMessageSuccessURL

public java.lang.String getSendConfirmationMessageSuccessURL()

Returns the property to store the success url for sending the appeasement confirmation message

Returns:

the property to store the success url for sending the appeasement confirmation message

setSendConfirmationMessageErrorURL

public void setSendConfirmationMessageErrorURL(java.lang.String pSendConfirmationMessageErrorURL)

Sets the property to store the error url for sending the appeasement confirmation message

Parameters:

pSendConfirmationMessageErrorURL - the property to store the error url for sending the appeasement confirmation message

getSendConfirmationMessageErrorURL

public java.lang.String getSendConfirmationMessageErrorURL()

Returns the error url property for sending the appeasement confirmation message

Returns:

the property to store the error url for sending the appeasement confirmation message

handleApplyAppeasementRefunds

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

This method calls AppeasementManager.applyRefundAmounts to generate a list of payment groups which were part of the original order.

Parameters:

pRequest - the servlet's request

pResponse - the servlet's response

Throws:

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

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

handleValidateAppeasementValues

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

This method is called to handle moving from the appeasement amount entry to the appeasement amount summary. It's primary responsibility is to validate the amounts entered.

Parameters:

pRequest - the servlet's request

pResponse - the servlet's response

Throws:

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

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

validateAppeasementValues

public void validateAppeasementValues(atg.servlet.DynamoHttpServletRequest pRequest,
                             atg.servlet.DynamoHttpServletResponse pResponse)

This method validates the amounts entered, ensuring that they are valid. i.e That they don't exceed the balance being appeased and that the allocations to the refund methods (credit card, store credit, etc) match the appeasement amount

Parameters:

pRequest - the servlet's request

pResponse - the servlet's response

preValidateAppeasementValues

public void preValidateAppeasementValues(atg.servlet.DynamoHttpServletRequest pRequest,
                                atg.servlet.DynamoHttpServletResponse pResponse)
                                  throws javax.servlet.ServletException,
                                         java.io.IOException

This method is called before any processing is done by the handleValidateAppeasementValues method.

Parameters:

pRequest - a value of type DynamoHttpServletRequest

pResponse - a value of type DynamoHttpServletResponse

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs

postValidateAppeasementValues

public void postValidateAppeasementValues(atg.servlet.DynamoHttpServletRequest pRequest,
                                 atg.servlet.DynamoHttpServletResponse pResponse)
                                   throws javax.servlet.ServletException,
                                          java.io.IOException

This method is called after all processing is done by the handleValidateAppeasementValues method.

Parameters:

pRequest - a value of type DynamoHttpServletRequest

pResponse - a value of type DynamoHttpServletResponse

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs

applyAppeasementRefunds

public void applyAppeasementRefunds(atg.servlet.DynamoHttpServletRequest pRequest,
                           atg.servlet.DynamoHttpServletResponse pResponse)
                             throws java.io.IOException,
                                    javax.servlet.ServletException

This method calls AppeasementManager.applyRefundAmounts to initialize the appeasement refund amounts order.

Parameters:

pRequest - the servlet's request

pResponse - the servlet's response

Throws:

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

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

atg.commerce.CommerceException - if an error occurs while applying the appeasement refunds

atg.repository.RepositoryException - if an error occurs while retrieving the the appeasement properties for a given order

preApplyAppeasementRefunds

public void preApplyAppeasementRefunds(atg.servlet.DynamoHttpServletRequest pRequest,
                              atg.servlet.DynamoHttpServletResponse pResponse)
                                throws javax.servlet.ServletException,
                                       java.io.IOException

This method is called before any processing is done by the handleApplyAppeasementRefunds method.

Parameters:

pRequest - a value of type DynamoHttpServletRequest

pResponse - a value of type DynamoHttpServletResponse

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs

postApplyAppeasementRefunds

public void postApplyAppeasementRefunds(atg.servlet.DynamoHttpServletRequest pRequest,
                               atg.servlet.DynamoHttpServletResponse pResponse)
                                 throws javax.servlet.ServletException,
                                        java.io.IOException

This method is called after all processing is done by the handleApplyAppeasementRefunds method.

Parameters:

pRequest - a value of type DynamoHttpServletRequest

pResponse - a value of type DynamoHttpServletResponse

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs

handleSubmitAppeasement

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

This method calls AppeasementManager.submitAppeasement to submit the current appeasement being processed

Parameters:

pRequest - the servlet's request

pResponse - the servlet's response

Throws:

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

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

submitAppeasement

public void submitAppeasement(atg.servlet.DynamoHttpServletRequest pRequest,
                     atg.servlet.DynamoHttpServletResponse pResponse)
                       throws java.io.IOException,
                              javax.servlet.ServletException

This method calls AppeasementManager.applyRefundAmounts to initialize the appeasement refund amounts order.

Parameters:

pRequest - the servlet's request

pResponse - the servlet's response

Throws:

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

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

atg.commerce.CommerceException - if an error occurs while applying the appeasement refunds

atg.repository.RepositoryException - if an error occurs while retrieving the the appeasement properties for a given order

preSubmitAppeasement

public void preSubmitAppeasement(atg.servlet.DynamoHttpServletRequest pRequest,
                        atg.servlet.DynamoHttpServletResponse pResponse)
                          throws javax.servlet.ServletException,
                                 java.io.IOException

This method is called before any processing is done by the handleSubmitAppeasement method.

Parameters:

pRequest - a value of type DynamoHttpServletRequest

pResponse - a value of type DynamoHttpServletResponse

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs

postSubmitAppeasement

public void postSubmitAppeasement(atg.servlet.DynamoHttpServletRequest pRequest,
                         atg.servlet.DynamoHttpServletResponse pResponse)
                           throws javax.servlet.ServletException,
                                  java.io.IOException

This method is called after all processing is done by the handleSubmitAppeasement method.

Parameters:

pRequest - a value of type DynamoHttpServletRequest

pResponse - a value of type DynamoHttpServletResponse

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs

handleCancelAppeasement

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

This method cancels the active process of appeasement creation

Parameters:

pRequest - the servlet's request

pResponse - the servlet's response

Throws:

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

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

preCancelAppeasement

public void preCancelAppeasement(atg.servlet.DynamoHttpServletRequest pRequest,
                        atg.servlet.DynamoHttpServletResponse pResponse)
                          throws javax.servlet.ServletException,
                                 java.io.IOException

This method is called before any processing is done by the handleCancelAppeasement method.

Parameters:

pRequest - a value of type DynamoHttpServletRequest

pResponse - a value of type DynamoHttpServletResponse

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs

postCancelAppeasement

public void postCancelAppeasement(atg.servlet.DynamoHttpServletRequest pRequest,
                         atg.servlet.DynamoHttpServletResponse pResponse)
                           throws javax.servlet.ServletException,
                                  java.io.IOException

This method is called after all processing is done by the handleCancelAppeasement method.

Parameters:

pRequest - a value of type DynamoHttpServletRequest

pResponse - a value of type DynamoHttpServletResponse

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs

cancelAppeasement

public void cancelAppeasement(atg.servlet.DynamoHttpServletRequest pRequest,
                     atg.servlet.DynamoHttpServletResponse pResponse)

This method cancels the active process of appeasement creation.

Also removes any store credit refund allocations made as part of the current appeasement.

Parameters:

pRequest - the servlet's request

pResponse - the servlet's response

Throws:

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

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

handleSendConfirmationMessage

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

Sends a confirmation email message regarding the new appeasement indicating whether it is successfully processed or is waiting for the approval

Parameters:

pRequest - the servlet's request

pResponse - the servlet's response

Returns:

true if sending the appeasement status email is successful and false otherwise

Throws:

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

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

sendConfirmationMessage

public void sendConfirmationMessage(atg.servlet.DynamoHttpServletRequest pRequest,
                           atg.servlet.DynamoHttpServletResponse pResponse)

Send the appeasement confirmation message using the the CSRAgentTools component

Parameters:

pRequest - the servlet's request

pResponse - the servlet's response

Throws:

atg.userprofiling.email.TemplateEmailException - if an error occurs in sending the confirmation message

preSendConfirmationMessage

public void preSendConfirmationMessage(atg.servlet.DynamoHttpServletRequest pRequest,
                              atg.servlet.DynamoHttpServletResponse pResponse)
                                throws javax.servlet.ServletException,
                                       java.io.IOException

This method is called before any processing is done by the handleSendConfirmationMessage method.

Parameters:

pRequest - a value of type DynamoHttpServletRequest

pResponse - a value of type DynamoHttpServletResponse

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs

postSendConfirmationMessage

public void postSendConfirmationMessage(atg.servlet.DynamoHttpServletRequest pRequest,
                               atg.servlet.DynamoHttpServletResponse pResponse)
                                 throws javax.servlet.ServletException,
                                        java.io.IOException

This method is called after all processing is done by the handleSendConfirmationMessage method.

Parameters:

pRequest - a value of type DynamoHttpServletRequest

pResponse - a value of type DynamoHttpServletResponse

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs

getReasonCodes

public java.util.List<atg.repository.RepositoryItem> getReasonCodes()

Retrieves a list of appeasement reason codes

initializeConfirmationInfo

protected ConfirmationInfo initializeConfirmationInfo(atg.commerce.csr.appeasement.Appeasement pAppeasement)

Initializes the confirmation info object for an appeasement

Parameters:

pAppeasement - The appeasement object.

Returns:

The initialized Confirmation info object.