atg.commerce.csr.returns

Class ModifyRefundValuesFormHandler

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.droplet.EmptyFormHandler

atg.droplet.GenericFormHandler

atg.commerce.csr.returns.ModifyRefundValuesFormHandler

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 ModifyRefundValuesFormHandler
extends atg.droplet.GenericFormHandler

This form handler is used to modify the actual refund values of the return request and reset the actual refund values back to the suggested values.

It provides the ability to update the actual refund value for each return item and the ReturnRequest's other, actual shipping and actual tax adjustment values

The process of apply new values includes validation of each value and to abort the process due to validation failures.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string
protected CSRAgentTools	mCSRAgentTools
protected java.lang.String	mModifyRefundValuesErrorURL
protected java.lang.String	mModifyRefundValuesSuccessURL
protected java.lang.String	mOtherAdjustment
protected java.lang.String	mPaymentPageURL
protected java.lang.String	mRefundPageURL
protected java.lang.String	mResetRefundValuesErrorURL
protected java.lang.String	mResetRefundValuesSuccessURL
protected java.util.Map	mReturnItemRefunds
protected atg.commerce.csr.returns.ReturnManager	mReturnManager
protected atg.commerce.csr.returns.ReturnRequest	mReturnRequest
protected java.lang.String	mShippingAdjustment
protected javax.transaction.TransactionManager	mTransactionManager
protected java.lang.String	mWashPageURL

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

Method Summary

Methods

Modifier and Type	Method and Description
protected void	applyOtherAdjustment() Sets the return request's other adjustment value from the form's other adjustment value.
protected void	applyReturnItemRefunds() Sets the actual refund amounts of each return item from the form's map of return item refund values.
protected void	applyShippingAdjustment() Sets the actual shipping from the form's shipping adjustment value.
protected java.lang.String	formatAmount(double pAmount) Provides a formatted string representation of the given double value.
CSRAgentTools	getCSRAgentTools()
protected java.lang.String	getItemRefundAmount(int pReturnItemIndex) returns the item refund amount from the returnItemRefunds Map for the ReturnItem at the given index in the returnItemList.
java.lang.String	getModifyRefundValuesErrorURL()
java.lang.String	getModifyRefundValuesSuccessURL()
java.lang.String	getOtherAdjustment() Returns the other adjustment value that will get set on the ReturnRequest.
java.lang.String	getPaymentPageURL()
java.lang.String	getRefundPageURL()
java.lang.String	getResetRefundValuesErrorURL() Returns property ErrorURL
java.lang.String	getResetRefundValuesSuccessURL() Returns property ResetRefundValuesSuccessURL
java.util.Map	getReturnItemRefunds() This method dynamically generates the Map and the values in it from the ReturnRequest if the Map is null.
atg.commerce.csr.returns.ReturnManager	getReturnManager() Returns the return manager object
atg.commerce.csr.returns.ReturnRequest	getReturnRequest()
java.lang.String	getShippingAdjustment() Returns the shipping adjustment value that will get set on the ReturnRequest.
javax.transaction.TransactionManager	getTransactionManager() Returns the transaction manager
protected java.util.Locale	getUserLocale() This method gets the current Locale
java.lang.String	getUserLocalizedResource(java.lang.String pKey, java.lang.Object[] pMsgArgs, java.util.Locale pLocale) Returns a formated user message for the given key, arguments and locale
java.lang.String	getWashPageURL()
boolean	handleModifyRefundValues(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse)
boolean	handleResetRefundValues(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse)
protected boolean	modifyRefundValues(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Validates and applies the form's refund values to the return request and return items.
protected double	parseAmount(java.lang.String pAmount) Parses the given amount into a double value.
protected boolean	postModifyRefundValues(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) This method is called after the refund values have been applied.
protected boolean	postResetRefundValues(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) This method is called after the resetting refund values.
protected boolean	preModifyRefundValues(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) This method is called before the refund values have been applied.
protected boolean	preResetRefundValues(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) This method is called before the resetting refund values.
protected boolean	resetRefundValues(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) called to reset the suggested values of the return.
void	setCSRAgentTools(CSRAgentTools pCSRAgentTools) Sets the property CSRAgentTools.
void	setModifyRefundValuesErrorURL(java.lang.String pModifyRefundValuesErrorURL)
void	setModifyRefundValuesSuccessURL(java.lang.String pModifyRefundValuesSuccessURL)
void	setOtherAdjustment(java.lang.String pOtherAdjustment)
void	setPaymentPageURL(java.lang.String pPaymentPageURL) Sets the PaymentPageURL.
void	setRefundPageURL(java.lang.String pRefundPageURL) Sets the refundMethodsPageURL.
void	setResetRefundValuesErrorURL(java.lang.String pResetRefundValuesErrorURL)
void	setResetRefundValuesSuccessURL(java.lang.String pResetRefundValuesSuccessURL)
void	setReturnItemRefunds(java.util.Map pReturnItemRefunds)
void	setReturnManager(atg.commerce.csr.returns.ReturnManager pReturnManager) sets the return manager object
void	setReturnRequest(atg.commerce.csr.returns.ReturnRequest pReturnRequest)
void	setShippingAdjustment(java.lang.String pShippingAdjustment)
void	setTransactionManager(javax.transaction.TransactionManager pTransactionManager) Sets the Transaction Manager
void	setWashPageURL(java.lang.String pWashURL) Sets the WashPageURL.
protected boolean	validateAdjustmentValues() Validates the refund values in the form's input properties.
protected boolean	validateOtherAdjustment(double pOtherAdjustment) Validates the other adjustment value
protected boolean	validateReturnItemRefund(atg.commerce.csr.returns.ReturnItem pReturnItem, double pRefundValue) Validates the refund item refund values.
protected boolean	validateShippingAdjustment(double pShippingAdjustment) Validates the shipping refund value

Methods inherited from class atg.droplet.GenericFormHandler

addFormException, addUncheckedFormException, afterSet, beforeSet, checkFormRedirect, createFormSubmissionMessage, getCancelURL, getCheckForValidSession, getFormError, getFormExceptions, getFormName, getMessagePort, getMessageSource, getMessageType, getPropertyExceptions, getSendMessages, getUncheckedFormExceptions, handleCancel, handleFormException, handleUncheckedFormException, hasUncheckedFormExceptions, isDeferForwardsAndRedirects, isRestorableForm, isUseForwards, isValidSession, redirectOrForward, resetFormExceptions, setCancelURL, setCheckForValidSession, setDeferForwardsAndRedirects, setFormName, setMessagePort, setMessageSource, setMessageType, setRestorableForm, setSendMessages, setUseForwards

Methods inherited from class atg.droplet.EmptyFormHandler

afterGet, beforeGet

Methods inherited from class atg.nucleus.GenericService

addLogListener, createAdminServlet, doStartService, doStopService, getAbsoluteName, getAdminServlet, getAdminServletOutputStreamEncoding, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isAdminServletUseServletOutputStream, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, reResolveThis, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setAdminServletOutputStreamEncoding, setAdminServletUseServletOutputStream, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService

Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

mOtherAdjustment

protected java.lang.String mOtherAdjustment

mShippingAdjustment

protected java.lang.String mShippingAdjustment

mReturnItemRefunds

protected java.util.Map mReturnItemRefunds

mRefundPageURL

protected java.lang.String mRefundPageURL

mPaymentPageURL

protected java.lang.String mPaymentPageURL

mWashPageURL

protected java.lang.String mWashPageURL

mReturnRequest

protected atg.commerce.csr.returns.ReturnRequest mReturnRequest

mModifyRefundValuesErrorURL

protected java.lang.String mModifyRefundValuesErrorURL

mModifyRefundValuesSuccessURL

protected java.lang.String mModifyRefundValuesSuccessURL

mResetRefundValuesErrorURL

protected java.lang.String mResetRefundValuesErrorURL

mResetRefundValuesSuccessURL

protected java.lang.String mResetRefundValuesSuccessURL

mTransactionManager

protected javax.transaction.TransactionManager mTransactionManager

mCSRAgentTools

protected CSRAgentTools mCSRAgentTools

mReturnManager

protected atg.commerce.csr.returns.ReturnManager mReturnManager

Constructor Detail

ModifyRefundValuesFormHandler

public ModifyRefundValuesFormHandler()

Method Detail

getOtherAdjustment

public java.lang.String getOtherAdjustment()

Returns the other adjustment value that will get set on the ReturnRequest.

The property will initialize itself based on the current otherRefund in the ReturnRequest.

Returns:

the other adjustment value that will get set on the ReturnRequest.

setOtherAdjustment

public void setOtherAdjustment(java.lang.String pOtherAdjustment)

getShippingAdjustment

public java.lang.String getShippingAdjustment()

Returns the shipping adjustment value that will get set on the ReturnRequest.

Whe null, this property will initialize itself based on the current actualShippingRefund in the ReturnRequest.

Returns:

the shipping adjustment value that will get set on the ReturnRequest.

setShippingAdjustment

public void setShippingAdjustment(java.lang.String pShippingAdjustment)

getRefundPageURL

public java.lang.String getRefundPageURL()

Returns:

the url that it used for a successful modification when the return request's returnPaymentState is ReturnPaymentState.REFUND. For example, the cost of the exchange order is less than the refund.

Note that this URL is only used in the successurl is not valued already.

setRefundPageURL

public void setRefundPageURL(java.lang.String pRefundPageURL)

Sets the refundMethodsPageURL.

Parameters:

pRefundMethodsPageURL -

getPaymentPageURL

public java.lang.String getPaymentPageURL()

Returns:

the url that it used for a successful modification when the return request's returnPaymentState is ReturnPaymentState.DUE. For example, the cost of the exchange order is more than the refund.

Note that this URL is only used in the successurl is not valued already.

setPaymentPageURL

public void setPaymentPageURL(java.lang.String pPaymentPageURL)

Sets the PaymentPageURL.

Parameters:

pPaymentPageURL -

getWashPageURL

public java.lang.String getWashPageURL()

Returns:

the url that it used for a successful modification when the return request's returnPaymentState is ReturnPaymentState.NONE. For example, there is no refund because the calculated refund is the same as the cost of the exchange order.

Note that this URL is only used in the successurl is not valued already.

setWashPageURL

public void setWashPageURL(java.lang.String pWashURL)

Sets the WashPageURL.

Parameters:

WashPageURL -

getReturnItemRefunds

public java.util.Map getReturnItemRefunds()

This method dynamically generates the Map and the values in it from the ReturnRequest if the Map is null. The values in the map are based on the current refundAmounts in each ReturnItem in the ReturnRequest

Returns:

the Map of return item refund values provided from the UI. The key is the index of the ReturnItem in the ReturnRequest returnItemList.

setReturnItemRefunds

public void setReturnItemRefunds(java.util.Map pReturnItemRefunds)

getReturnRequest

public atg.commerce.csr.returns.ReturnRequest getReturnRequest()

setReturnRequest

public void setReturnRequest(atg.commerce.csr.returns.ReturnRequest pReturnRequest)

setModifyRefundValuesErrorURL

public void setModifyRefundValuesErrorURL(java.lang.String pModifyRefundValuesErrorURL)

getModifyRefundValuesErrorURL

public java.lang.String getModifyRefundValuesErrorURL()

Returns:

a String value

setModifyRefundValuesSuccessURL

public void setModifyRefundValuesSuccessURL(java.lang.String pModifyRefundValuesSuccessURL)

getModifyRefundValuesSuccessURL

public java.lang.String getModifyRefundValuesSuccessURL()

Returns:

a String value

setResetRefundValuesErrorURL

public void setResetRefundValuesErrorURL(java.lang.String pResetRefundValuesErrorURL)

getResetRefundValuesErrorURL

public java.lang.String getResetRefundValuesErrorURL()

Returns property ErrorURL

Returns:

a String value

setResetRefundValuesSuccessURL

public void setResetRefundValuesSuccessURL(java.lang.String pResetRefundValuesSuccessURL)

getResetRefundValuesSuccessURL

public java.lang.String getResetRefundValuesSuccessURL()

Returns property ResetRefundValuesSuccessURL

Returns:

a String value

setTransactionManager

public void setTransactionManager(javax.transaction.TransactionManager pTransactionManager)

Sets the Transaction Manager

Parameters:

pTransactionManager -

getTransactionManager

public javax.transaction.TransactionManager getTransactionManager()

Returns the transaction manager

setCSRAgentTools

public void setCSRAgentTools(CSRAgentTools pCSRAgentTools)

Sets the property CSRAgentTools.

getCSRAgentTools

public CSRAgentTools getCSRAgentTools()

Returns:

The value of the property CSRAgentTools.

setReturnManager

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

sets the return manager object

Parameters:

pReturnManager - the return manager

getReturnManager

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

Returns the return manager object

validateReturnItemRefund

protected boolean validateReturnItemRefund(atg.commerce.csr.returns.ReturnItem pReturnItem,
                               double pRefundValue)

Validates the refund item refund values.

Returns:

true if validation passed. false will cause validation to abort the modification process.

validateShippingAdjustment

protected boolean validateShippingAdjustment(double pShippingAdjustment)

Validates the shipping refund value

Returns:

true if validation passed. false will cause validation to abort the modification process.

validateOtherAdjustment

protected boolean validateOtherAdjustment(double pOtherAdjustment)

Validates the other adjustment value

Returns:

true if validation passed. false will cause validation to abort the modification process.

validateAdjustmentValues

protected boolean validateAdjustmentValues()

Validates the refund values in the form's input properties.

Returns:

true if validation passed. false will cause validation to abort the modification process.

getItemRefundAmount

protected java.lang.String getItemRefundAmount(int pReturnItemIndex)

returns the item refund amount from the returnItemRefunds Map for the ReturnItem at the given index in the returnItemList.

Parameters:

pReturnItemIndex -

Returns:

refund value.

handleModifyRefundValues

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

Throws:

javax.servlet.ServletException

java.io.IOException

preModifyRefundValues

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

This method is called before the refund values have been applied.

Parameters:

pRequest -

pResponse -

Returns:

false if redirected

Throws:

javax.servlet.ServletException

java.io.IOException

postModifyRefundValues

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

This method is called after the refund values have been applied.

Parameters:

pRequest -

pResponse -

Returns:

false if redirected

Throws:

javax.servlet.ServletException

java.io.IOException

modifyRefundValues

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

Validates and applies the form's refund values to the return request and return items.

Parameters:

pRequest -

pResponse -

Returns:

false if redirected

Throws:

javax.servlet.ServletException

java.io.IOException

applyReturnItemRefunds

protected void applyReturnItemRefunds()

Sets the actual refund amounts of each return item from the form's map of return item refund values.

applyShippingAdjustment

protected void applyShippingAdjustment()

Sets the actual shipping from the form's shipping adjustment value.

applyOtherAdjustment

protected void applyOtherAdjustment()

Sets the return request's other adjustment value from the form's other adjustment value.

parseAmount

protected double parseAmount(java.lang.String pAmount)
                      throws java.text.ParseException

Parses the given amount into a double value.

Parameters:

pAmount - the amount to parse

Returns:

the double value

Throws:

java.text.ParseException

See Also:

CSRAgentTools.parseAmount(String, String)

formatAmount

protected java.lang.String formatAmount(double pAmount)

Provides a formatted string representation of the given double value.

Parameters:

pAmount -

Returns:

the string representation of pAmount

See Also:

CSRAgentTools.formatAmount(double, String)

getUserLocale

protected java.util.Locale getUserLocale()

This method gets the current Locale

Returns:

the current Locale

getUserLocalizedResource

public java.lang.String getUserLocalizedResource(java.lang.String pKey,
                                        java.lang.Object[] pMsgArgs,
                                        java.util.Locale pLocale)

Returns a formated user message for the given key, arguments and locale

Parameters:

pKey -

pMsgArgs -

pLocale -

Returns:

handleResetRefundValues

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

Throws:

javax.servlet.ServletException

java.io.IOException

preResetRefundValues

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

This method is called before the resetting refund values.

Parameters:

pRequest -

pResponse -

Returns:

false if redirected

Throws:

javax.servlet.ServletException

java.io.IOException

postResetRefundValues

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

This method is called after the resetting refund values.

Parameters:

pRequest -

pResponse -

Returns:

false if redirected

Throws:

javax.servlet.ServletException

java.io.IOException

resetRefundValues

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

called to reset the suggested values of the return.

Parameters:

pRequest -

pResponse -

Returns:

Throws:

javax.servlet.ServletException

java.io.IOException