public class ReturnFormHandler
extends atg.commerce.csr.returns.BaseReturnFormHandler
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string
|
protected boolean |
mAutoSendEmail |
protected ConfirmationInfo |
mConfirmationInfo |
protected java.lang.String |
mSelectItemsAndStartReturnErrorURL |
protected java.lang.String |
mSelectItemsAndStartReturnSuccessURL |
static java.lang.String |
MSG_ERROR_DURING_PAYMENT_GROUPS_VALIDATION |
static java.lang.String |
MSG_ERROR_PROCESSING_SELECTED_ITEMS |
static java.lang.String |
MSG_ERROR_QUANTITY_FOR_ITEM |
static java.lang.String |
MSG_ERROR_RECEIVING_RETURN_ITEM |
static java.lang.String |
MSG_ERROR_SENDING_RETURN_EMAIL_CONFIRM |
static java.lang.String |
MSG_ERROR_WHILE_BUILDING_REFUND_METHODS |
static java.lang.String |
MSG_ERROR_WHILE_CHANGING_ORDER |
static java.lang.String |
MSG_ERROR_WHILE_CREATING_NEW_ORDER |
static java.lang.String |
MSG_INVALID_QUANTITY |
static java.lang.String |
MSG_NO_DISPOSITION |
static java.lang.String |
MSG_NO_RETURN_QUANTITY |
static java.lang.String |
MSG_NO_RETURN_QUANTITY_FOR_ITEM |
static java.lang.String |
MSG_NO_RETURN_REASON |
static java.lang.String |
MSG_NO_SELECTED_ITEMS |
static java.lang.String |
MSG_NO_SELECTED_TO_RECEIVE_ITEMS |
static java.lang.String |
MSG_RETURN_QUANTITY_CANT_BE_NEGATIVE |
static java.lang.String |
MSG_SET_RETURN_SHIPMENT_REQUIRED |
static java.lang.String |
MSG_UNABLE_TO_CREATE_ORDER |
static java.lang.String |
NO_CURRENT_ORDER |
static java.lang.String |
NO_RETURN_REQUEST |
static java.lang.String |
ORDER_EXCHANGE_TEMPLATE_NAME
Key that identifies the email template to use when sending an exhange order confirmation.
|
static java.lang.String |
ORDER_RETURN_TEMPLATE_NAME
Key that identifies the email template to use when sending a return confirmation.
|
static java.lang.String |
RETURN_REQUEST_PARAM_NAME
key used to store the return request in the extr data Map of the the
ConfirmationInfo |
mApplyRefundsErrorURL, mApplyRefundsSuccessURL, mCancelReturnRequestErrorURL, mCancelReturnRequestSuccessURL, mConfirmReturnErrorURL, mCreateReturnRequestPipelineChainId, mCreateReturnRequestProcessName, mOriginOfReturn, mReplacementOrderSalesChannel, mReturnManager, mReturnOrderId, mReturnRequest, mSelectAllItems, mSelectAllItemsReturnReason, mSelectItemsErrorURL, mSelectItemsProcessName, mSelectItemsSuccessURL, MSG_ERROR_APPLYING_SELECTED_ITEMS, MSG_ERROR_CONFIRMING_RETURN_REQUEST, MSG_ERROR_WHILE_CREATING_RETURN_REQUEST, mSortedRefundMethodList
LOCK_NAME_ATTRIBUTE_NAME, PARAM_TRANSACTION_CREATED, PARAM_VALUE_TRUE
PARAM_DEFER_FORWARD_OR_REDIRECT, PARAM_USE_FORWARDS
Constructor and Description |
---|
ReturnFormHandler() |
Modifier and Type | Method and Description |
---|---|
void |
applyRefunds(atg.servlet.DynamoHttpServletRequest pRequest,
atg.servlet.DynamoHttpServletResponse pResponse)
After applying refund values, this extension will recalculate
payment group values if working on an exchange.
|
void |
createNewOrder()
This method calls the
EnvironmentTools and creates new order. |
protected java.util.Map |
generateConfirmExtraParameters()
Called to generate the extra parameters that are passed to the confirmation
pipeline.
|
protected java.util.Map |
generateCreateReturnRequestExtraParameters()
Adds the replacement order origin and ticket id parameters
|
protected java.util.Map |
generateReceiveItemExtraParameters(atg.commerce.csr.returns.ReturnRequest pReturnRequest,
atg.commerce.csr.returns.ReturnItem pReturnItem,
long pQuantityReceived,
java.lang.String pDisposition)
Called to generate the Map of extra parameters passed to the receive pipeline
|
protected java.util.Map |
generateSelectItemsAndStartReturnExtraParameters()
Adds the parameter to disable the refund total validation is the selection
pipeline.
|
protected java.util.Map |
generateSelectItemsExtraParameters()
Adds the parameter to disable the refund total validation is the selection
pipeline.
|
CSRAgentMessagingTools |
getAgentMessagingTools()
Returns component for sending agent messages
|
atg.userprofiling.Profile |
getAgentProfile()
Returns the profile of the agent working on the return
|
ConfirmationInfo |
getConfirmationInfo()
Returns the confirmation info object used for sending email confirmations.
|
CSRAgentTools |
getCSRAgentTools()
Returns the cSRAgentTools.
|
java.lang.String |
getDisposition() |
java.util.List |
getDispositionCodes()
Retrieve a list of disposition codes
|
java.util.Map |
getProgressBarItems()
Returns the progressBarItems.
|
long |
getQuantityReceived() |
java.util.Map |
getReceiveItemQuantities()
Returns Receive Item Quantities
|
java.lang.String |
getReceiveReturnItemsErrorURL() |
java.lang.String |
getReceiveReturnItemsSuccessURL() |
atg.commerce.csr.returns.ReturnItem |
getReturnItem() |
java.util.Map |
getReturnItemDispositions()
Returns ReturnItemDispositions
|
java.lang.String |
getReturnItemId() |
java.util.Map |
getReturnItemsRequests()
Returns couples of returnItem id and returnRequest id
|
java.lang.String |
getReturnRequestId()
Returns the current return request id
|
atg.commerce.csr.returns.ReturnsDataHolder |
getReturnsDataHolder()
Resolves the requested data-holder
|
java.lang.String |
getReturnsDataHolderPath()
Returns the returnsDataHolderPath.
|
atg.commerce.csr.returns.ReturnTools |
getReturnTools() |
java.lang.String |
getSelectItemsAndStartReturnErrorURL() |
java.lang.String |
getSelectItemsAndStartReturnSuccessURL() |
java.lang.String |
getSelectReturnItemsErrorURL() |
java.lang.String |
getSelectReturnItemsSuccessURL() |
java.lang.String |
getStartExchangeProcessErrorURL() |
java.lang.String |
getStartExchangeProcessSuccessURL() |
java.lang.String |
getStartReturnProcessErrorURL() |
java.lang.String |
getStartReturnProcessSuccessURL() |
java.lang.String |
getTicketId()
Returns the Id of the current ticket
|
boolean |
handleReceiveReturnItems(atg.servlet.DynamoHttpServletRequest pRequest,
atg.servlet.DynamoHttpServletResponse pResponse)
Records the receipt of return merchandise
|
boolean |
handleSelectItemsAndStartReturn(atg.servlet.DynamoHttpServletRequest pRequest,
atg.servlet.DynamoHttpServletResponse pResponse)
Deprecated.
|
boolean |
handleSelectReturnItems(atg.servlet.DynamoHttpServletRequest pRequest,
atg.servlet.DynamoHttpServletResponse pResponse)
Deprecated.
|
boolean |
handleStartExchangeProcess(atg.servlet.DynamoHttpServletRequest pRequest,
atg.servlet.DynamoHttpServletResponse pResponse)
Deprecated.
|
boolean |
handleStartReturnProcess(atg.servlet.DynamoHttpServletRequest pRequest,
atg.servlet.DynamoHttpServletResponse pResponse)
Deprecated.
|
protected void |
initializeConfirmationInfoReturn(atg.servlet.DynamoHttpServletRequest pRequest,
atg.servlet.DynamoHttpServletResponse pResponse)
Initializes the confirmation info object when returns and exchanges are submitted
|
boolean |
isAutoSendEmail()
Gets the AutoSendEmail
|
void |
loadReplacementOrder(atg.commerce.csr.returns.ReturnRequest pReturnRequest)
Loads the return request's replacement order as the active order in the
environment.
|
void |
postCancelReturnRequest(atg.servlet.DynamoHttpServletRequest pRequest,
atg.servlet.DynamoHttpServletResponse pResponse)
This method is called after all processing is done by the
handleCancelReturnRequest method.
|
void |
postConfirmReturn(atg.servlet.DynamoHttpServletRequest pRequest,
atg.servlet.DynamoHttpServletResponse pResponse)
This is called after all processing is done by the
handleConfirmReturn method.
|
void |
postReceiveReturnItems(atg.servlet.DynamoHttpServletRequest pRequest,
atg.servlet.DynamoHttpServletResponse pResponse)
This is called after all processing is done by the
handleReceiveReturnItems method.
|
void |
postSelectItems(atg.servlet.DynamoHttpServletRequest pRequest,
atg.servlet.DynamoHttpServletResponse pResponse)
This is called after any processing is done by the
handleSelectItems method.
|
void |
postSelectItemsAndStartReturn(atg.servlet.DynamoHttpServletRequest pRequest,
atg.servlet.DynamoHttpServletResponse pResponse)
Deprecated.
|
void |
postSelectReturnItems(atg.servlet.DynamoHttpServletRequest pRequest,
atg.servlet.DynamoHttpServletResponse pResponse)
Deprecated.
|
void |
postStartExchangeProcess(atg.servlet.DynamoHttpServletRequest pRequest,
atg.servlet.DynamoHttpServletResponse pResponse)
Deprecated.
|
void |
postStartReturnProcess(atg.servlet.DynamoHttpServletRequest pRequest,
atg.servlet.DynamoHttpServletResponse pResponse)
Deprecated.
|
void |
preConfirmReturn(atg.servlet.DynamoHttpServletRequest pRequest,
atg.servlet.DynamoHttpServletResponse pResponse)
This is called before any processing is done by the
handleConfirmReturn method.
|
void |
preReceiveReturnItems(atg.servlet.DynamoHttpServletRequest pRequest,
atg.servlet.DynamoHttpServletResponse pResponse)
This is called before any processing is done by the
handleReceiveReturnItems method.
|
void |
preSelectItemsAndStartReturn(atg.servlet.DynamoHttpServletRequest pRequest,
atg.servlet.DynamoHttpServletResponse pResponse)
Deprecated.
|
void |
preSelectReturnItems(atg.servlet.DynamoHttpServletRequest pRequest,
atg.servlet.DynamoHttpServletResponse pResponse)
Deprecated.
|
void |
preStartExchangeProcess(atg.servlet.DynamoHttpServletRequest pRequest,
atg.servlet.DynamoHttpServletResponse pResponse)
Deprecated.
|
void |
preStartReturnProcess(atg.servlet.DynamoHttpServletRequest pRequest,
atg.servlet.DynamoHttpServletResponse pResponse)
Deprecated.
|
boolean |
receiveReturnItem(atg.servlet.DynamoHttpServletRequest pRequest,
atg.servlet.DynamoHttpServletResponse pResponse)
Records the receipt of a return shipment
|
void |
receiveReturnItems(atg.servlet.DynamoHttpServletRequest pRequest,
atg.servlet.DynamoHttpServletResponse pResponse)
Records the receipt of a return shipment
|
void |
runProcessValidatePaymentGroups(atg.commerce.order.Order pOrder,
java.util.Locale pLocale,
java.util.Map pExtraParameters)
runProcessValidatePaymentGroups runs a configurable Pipeline chain
to validate PaymentGroups or to prepare for the next checkout phase. |
void |
selectItemsAndStartReturn(atg.servlet.DynamoHttpServletRequest pRequest,
atg.servlet.DynamoHttpServletResponse pResponse)
Deprecated.
|
void |
selectReturnItems(atg.servlet.DynamoHttpServletRequest pRequest,
atg.servlet.DynamoHttpServletResponse pResponse)
Deprecated.
|
protected void |
sendAgentEventsForReceiveItems(java.lang.String pReturnRequestId,
java.util.Map<java.lang.String,java.lang.Long> pQuantityBeingReceived,
java.util.Map<java.lang.String,java.lang.String> pDispositionReceived)
Sends agent events related to receiving the items.
|
void |
sendReceiveReturnItemEvent(atg.commerce.csr.returns.ReturnRequest pReturnRequest,
java.lang.String pCommerceItemId,
long pQuantity)
Sends a ReceiveReturnItem JMS event
|
void |
sendReturnEventMessage(atg.commerce.csr.returns.ReturnRequest pReturnRequest)
Sends either a ReturnOrder or ExchangeOrder event (based on whether or not the returnRequest
has a replacementOrder) through the AgentMessagingTools
|
void |
setAgentMessagingTools(CSRAgentMessagingTools pAgentMessagingTools)
Sets the component for sending agent messages
|
void |
setAgentProfile(atg.userprofiling.Profile pAgentProfile)
Sets the profile of the agent working on the return
|
void |
setAutoSendEmail(boolean pAutoSendEmail)
Sets the AutoSendEmail
|
void |
setConfirmationInfo(ConfirmationInfo pConfirmationInfo) |
void |
setCSRAgentTools(CSRAgentTools pAgentTools)
Sets the cSRAgentTools.
|
void |
setDisposition(java.lang.String pDisposition)
Sets the disposition of a return item
|
void |
setProgressBarItems(java.util.Map pProgressBarItems)
Sets the progressBarItems.
|
void |
setQuantityReceived(long pQuantityReceived)
The quantity of a return item that was received
|
void |
setReceiveItemQuantities(java.util.Map pReceiveItemQuantities)
Sets Receive Item Quantities
|
void |
setReceiveReturnItemsErrorURL(java.lang.String pReceiveReturnItemsErrorURL)
Sets URL to go to after an error occurs in handleReceiveReturnItems
|
void |
setReceiveReturnItemsSuccessURL(java.lang.String pReceiveReturnItemsSuccessURL)
Sets URL to go to after handleReceiveReturnItems successfully runs.
|
void |
setReturnItem(atg.commerce.csr.returns.ReturnItem pReturnItem)
sets the return item to operate on
|
void |
setReturnItemDispositions(java.util.Map pReturnItemDispositions)
Sets ReturnItemDispositions
|
void |
setReturnItemId(java.lang.String pReturnItemId)
sets the id of the return item to operate on
|
void |
setReturnItemsRequests(java.util.Map pReturnItemsRequests)
Sets couples of returnItem id and returnRequest id
|
void |
setReturnRequestId(java.lang.String pReturnRequestId)
Sets the current return request id
|
void |
setReturnsDataHolderPath(java.lang.String pReturnsDataHolderPath)
Sets the returnsDataHolderPath.
|
void |
setSelectItemsAndStartReturnErrorURL(java.lang.String pSelectItemsAndStartReturnErrorURL)
Sets URL to go to after an error occurs in handleSelectItemsAndStartReturn
|
void |
setSelectItemsAndStartReturnSuccessURL(java.lang.String pSelectItemsAndStartReturnSuccessURL)
Sets URL to go to after handleSelectItemsAndStartReturn successfully runs.
|
void |
setSelectReturnItemsErrorURL(java.lang.String pSelectReturnItemsErrorURL)
Sets URL to go to after an error occurs in handleSelectReturnItems
|
void |
setSelectReturnItemsSuccessURL(java.lang.String pSelectReturnItemsSuccessURL)
Sets URL to go to after handleSelectReturnItems successfully runs.
|
void |
setStartExchangeProcessErrorURL(java.lang.String pStartExchangeProcessErrorURL) |
void |
setStartExchangeProcessSuccessURL(java.lang.String pStartExchangeProcessSuccessURL) |
void |
setStartReturnProcessErrorURL(java.lang.String pStartReturnProcessErrorURL) |
void |
setStartReturnProcessSuccessURL(java.lang.String pStartReturnProcessSuccessURL) |
void |
startExchangeProcess(atg.servlet.DynamoHttpServletRequest pRequest,
atg.servlet.DynamoHttpServletResponse pResponse)
Deprecated.
in favor of atg.commerce.csr.returns.BaseReturnFormHandler#selectItemsAndStartReturn(DynamoHttpServletRequest,DynamoHttpServletResponse,
|
void |
startReturnProcess(atg.servlet.DynamoHttpServletRequest pRequest,
atg.servlet.DynamoHttpServletResponse pResponse)
Deprecated.
|
protected void |
validateSelectedItems(atg.servlet.DynamoHttpServletRequest pRequest,
atg.servlet.DynamoHttpServletResponse pResponse)
Validates that there is at least one ReturnItem object selected for return (e.g.
|
cancelReturnRequest, confirmReturn, createReturnRequest, generateApplyRefundAllocationsExtraParameters, getApplyRefundsErrorURL, getApplyRefundsSuccessURL, getCancelReturnRequestErrorURL, getCancelReturnRequestSuccessURL, getConfirmReturnErrorURL, getConfirmReturnSuccessURL, getCreateReturnRequestErrorURL, getCreateReturnRequestPipelineChainId, getCreateReturnRequestProcessName, getCreateReturnRequestSuccessURL, getModifiableRefundMethodList, getOriginOfReturn, getOriginOfReturn, getReasonCodes, getReplacementOrderSalesChannel, getReturnManager, getReturnOrderId, getReturnRequest, getSelectAllItemsReturnReason, getSelectItemsErrorURL, getSelectItemsProcessName, getSelectItemsSuccessURL, getSortedRefundMethodList, handleApplyRefunds, handleCancelReturnRequest, handleConfirmReturn, handleCreateReturnRequest, handleSelectItems, isSelectAllItems, postApplyRefunds, postCreateReturnRequest, preApplyRefunds, preCancelReturnRequest, preCreateReturnRequest, preSelectItems, rollbackTransaction, selectAllReturnItems, selectItems, setApplyRefundsErrorURL, setApplyRefundsSuccessURL, setCancelReturnRequestErrorURL, setCancelReturnRequestSuccessURL, setConfirmReturnErrorURL, setConfirmReturnSuccessURL, setCreateReturnRequestErrorURL, setCreateReturnRequestPipelineChainId, setCreateReturnRequestProcessName, setCreateReturnRequestSuccessURL, setReplacementOrderSalesChannel, setReturnManager, setReturnOrderId, setReturnRequest, setSelectAllItems, setSelectAllItemsReturnReason, setSelectItemsErrorURL, setSelectItemsProcessName, setSelectItemsSuccessURL, setSortedRefundMethodList
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, getTransactionManager, 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, setTransactionManager, setTransactionToRollbackOnly, setUseLocksAroundTransactions, setUseRequestLocale, setUserLocale, setUserPricingModels, transactionLockName, unsetTransactionCreated
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
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
vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning
public static java.lang.String CLASS_VERSION
public static final java.lang.String MSG_ERROR_PROCESSING_SELECTED_ITEMS
public static final java.lang.String MSG_INVALID_QUANTITY
public static final java.lang.String MSG_RETURN_QUANTITY_CANT_BE_NEGATIVE
public static final java.lang.String MSG_NO_RETURN_REASON
public static final java.lang.String MSG_NO_SELECTED_ITEMS
public static final java.lang.String MSG_NO_SELECTED_TO_RECEIVE_ITEMS
public static final java.lang.String ORDER_EXCHANGE_TEMPLATE_NAME
public static final java.lang.String ORDER_RETURN_TEMPLATE_NAME
public static final java.lang.String RETURN_REQUEST_PARAM_NAME
ConfirmationInfo
public static final java.lang.String NO_CURRENT_ORDER
public static final java.lang.String NO_RETURN_REQUEST
public static final java.lang.String MSG_ERROR_WHILE_CHANGING_ORDER
public static final java.lang.String MSG_ERROR_WHILE_BUILDING_REFUND_METHODS
public static final java.lang.String MSG_ERROR_WHILE_CREATING_NEW_ORDER
public static final java.lang.String MSG_ERROR_DURING_PAYMENT_GROUPS_VALIDATION
public static final java.lang.String MSG_ERROR_SENDING_RETURN_EMAIL_CONFIRM
public static final java.lang.String MSG_ERROR_RECEIVING_RETURN_ITEM
public static final java.lang.String MSG_NO_RETURN_QUANTITY
public static final java.lang.String MSG_NO_RETURN_QUANTITY_FOR_ITEM
public static final java.lang.String MSG_ERROR_QUANTITY_FOR_ITEM
public static final java.lang.String MSG_NO_DISPOSITION
public static final java.lang.String MSG_UNABLE_TO_CREATE_ORDER
public static final java.lang.String MSG_SET_RETURN_SHIPMENT_REQUIRED
protected ConfirmationInfo mConfirmationInfo
protected java.lang.String mSelectItemsAndStartReturnErrorURL
protected java.lang.String mSelectItemsAndStartReturnSuccessURL
protected boolean mAutoSendEmail
public ConfirmationInfo getConfirmationInfo()
public void setConfirmationInfo(ConfirmationInfo pConfirmationInfo)
public java.lang.String getReturnsDataHolderPath()
public void setReturnsDataHolderPath(java.lang.String pReturnsDataHolderPath)
pReturnsDataHolderPath
- public CSRAgentTools getCSRAgentTools()
public void setCSRAgentTools(CSRAgentTools pAgentTools)
pAgentTools
- public java.util.Map getProgressBarItems()
public void setProgressBarItems(java.util.Map pProgressBarItems)
pProgressBarItems
- public java.lang.String getStartExchangeProcessErrorURL()
public void setStartExchangeProcessErrorURL(java.lang.String pStartExchangeProcessErrorURL)
pStartExchangeProcessErrorURL
- The startExchangeProcessErrorURL to set.public java.lang.String getStartExchangeProcessSuccessURL()
public void setStartExchangeProcessSuccessURL(java.lang.String pStartExchangeProcessSuccessURL)
pStartExchangeProcessSuccessURL
- The startExchangeProcessSuccessURL to set.public java.lang.String getStartReturnProcessErrorURL()
public void setStartReturnProcessErrorURL(java.lang.String pStartReturnProcessErrorURL)
pStartReturnProcessErrorURL
- The startReturnProcessErrorURL to set.public java.lang.String getStartReturnProcessSuccessURL()
public void setStartReturnProcessSuccessURL(java.lang.String pStartReturnProcessSuccessURL)
pStartReturnProcessSuccessURL
- The startReturnProcessSuccessURL to set.public void setSelectItemsAndStartReturnErrorURL(java.lang.String pSelectItemsAndStartReturnErrorURL)
pSelectItemsAndStartReturnErrorURL
- the URL to go to after an error
occurs in handleSelectItemsAndStartReturnpublic java.lang.String getSelectItemsAndStartReturnErrorURL()
public void setSelectItemsAndStartReturnSuccessURL(java.lang.String pSelectItemsAndStartReturnSuccessURL)
pSelectItemsAndStartReturnSuccessURL
- the URL to go to after
handleSelectItemsAndStartReturn successfully runs.public java.lang.String getSelectItemsAndStartReturnSuccessURL()
public void setAgentMessagingTools(CSRAgentMessagingTools pAgentMessagingTools)
pAgentMessagingTools
- public CSRAgentMessagingTools getAgentMessagingTools()
public void setAgentProfile(atg.userprofiling.Profile pAgentProfile)
pAgentProfile
- the profile of the agent working on the returnpublic atg.userprofiling.Profile getAgentProfile()
public boolean isAutoSendEmail()
public void setAutoSendEmail(boolean pAutoSendEmail)
pAutoSendEmail
- The AutoSendEmail to setpublic void setDisposition(java.lang.String pDisposition)
pDisposition
- the disposition of a return itempublic java.lang.String getDisposition()
public void setQuantityReceived(long pQuantityReceived)
pQuantityReceived
- the quantity of a return item that was receivedpublic long getQuantityReceived()
public java.util.List getDispositionCodes()
public void setReceiveItemQuantities(java.util.Map pReceiveItemQuantities)
pReceiveItemQuantities
- public java.util.Map getReceiveItemQuantities()
public void setReturnItemsRequests(java.util.Map pReturnItemsRequests)
pReturnItemsRequests
- public java.util.Map getReturnItemsRequests()
public void setReturnItemDispositions(java.util.Map pReturnItemDispositions)
pReturnItemDispositions
- public java.util.Map getReturnItemDispositions()
public void setReceiveReturnItemsErrorURL(java.lang.String pReceiveReturnItemsErrorURL)
pReceiveReturnItemsErrorURL
- the URL to go to after an error
occurs in handleReceiveReturnItemspublic java.lang.String getReceiveReturnItemsErrorURL()
public void setReceiveReturnItemsSuccessURL(java.lang.String pReceiveReturnItemsSuccessURL)
pReceiveReturnItemsSuccessURL
- the URL to go to after
handleReceiveReturnItems successfully runs.public java.lang.String getReceiveReturnItemsSuccessURL()
public void setReturnItem(atg.commerce.csr.returns.ReturnItem pReturnItem)
pReturnItem
- the return item to operate onpublic atg.commerce.csr.returns.ReturnItem getReturnItem()
public void setReturnItemId(java.lang.String pReturnItemId)
pReturnItemId
- the id of the return item to operate onpublic java.lang.String getReturnItemId()
public void setReturnRequestId(java.lang.String pReturnRequestId)
pReturnRequestId
- the current return request idpublic java.lang.String getReturnRequestId()
public atg.commerce.csr.returns.ReturnTools getReturnTools()
public void setSelectReturnItemsErrorURL(java.lang.String pSelectReturnItemsErrorURL)
pSelectReturnItemsErrorURL
- the URL to go to after an error
occurs in handleSelectReturnItemspublic java.lang.String getSelectReturnItemsErrorURL()
public void setSelectReturnItemsSuccessURL(java.lang.String pSelectReturnItemsSuccessURL)
pSelectReturnItemsSuccessURL
- the URL to go to after
handleSelectReturnItems successfully runs.public java.lang.String getSelectReturnItemsSuccessURL()
public void postConfirmReturn(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
postConfirmReturn
in class atg.commerce.csr.returns.BaseReturnFormHandler
pRequest
- a value of type 'DynamoHttpServletRequest'pResponse
- a value of type 'DynamoHttpServletResponse'javax.servlet.ServletException
- if an error occursjava.io.IOException
- if an error occursprotected void initializeConfirmationInfoReturn(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse)
pRequest
- pResponse
- public void sendReturnEventMessage(atg.commerce.csr.returns.ReturnRequest pReturnRequest)
pReturnRequest
- the return requestpublic void preReceiveReturnItems(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
pRequest
- a value of type 'DynamoHttpServletRequest'pResponse
- a value of type 'DynamoHttpServletResponse'javax.servlet.ServletException
- if an error occursjava.io.IOException
- if an error occurspublic void postReceiveReturnItems(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
pRequest
- a value of type 'DynamoHttpServletRequest'pResponse
- a value of type 'DynamoHttpServletResponse'javax.servlet.ServletException
- if an error occursjava.io.IOException
- if an error occurspublic boolean handleReceiveReturnItems(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
pRequest
- the servlet's requestpResponse
- the servlet's responsejavax.servlet.ServletException
- if there was an error while executing the codejava.io.IOException
- if there was an error with servlet iopublic void receiveReturnItems(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
pRequest
- the servlet's requestpResponse
- the servlet's responsejavax.servlet.ServletException
- if there was an error while executing the codejava.io.IOException
- if there was an error with servlet ioprotected void sendAgentEventsForReceiveItems(java.lang.String pReturnRequestId, java.util.Map<java.lang.String,java.lang.Long> pQuantityBeingReceived, java.util.Map<java.lang.String,java.lang.String> pDispositionReceived)
pReturnRequestId
- the id of the return requestpQuantityBeingReceived
- a Map of return item id to quantity being receivedpDispositionReceived
- a Map of return item id to recieve dispositionpublic boolean receiveReturnItem(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
pRequest
- the servlet's requestpResponse
- the servlet's responsejavax.servlet.ServletException
- if there was an error while executing the codejava.io.IOException
- if there was an error with servlet ioprotected java.util.Map generateReceiveItemExtraParameters(atg.commerce.csr.returns.ReturnRequest pReturnRequest, atg.commerce.csr.returns.ReturnItem pReturnItem, long pQuantityReceived, java.lang.String pDisposition)
pReturnRequest
- pReturnItem
- pQuantityReceived
- pDisposition
- public void sendReceiveReturnItemEvent(atg.commerce.csr.returns.ReturnRequest pReturnRequest, java.lang.String pCommerceItemId, long pQuantity)
pReturnRequest
- the return requestpCommerceItemId
- the id of the commerce item that was returnedpQuantity
- the quantity of item receivedpublic void preSelectReturnItems(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
pRequest
- a value of type 'DynamoHttpServletRequest'pResponse
- a value of type 'DynamoHttpServletResponse'javax.servlet.ServletException
- if an error occursjava.io.IOException
- if an error occurspublic void postSelectReturnItems(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
pRequest
- a value of type 'DynamoHttpServletRequest'pResponse
- a value of type 'DynamoHttpServletResponse'javax.servlet.ServletException
- if an error occursjava.io.IOException
- if an error occurspublic boolean handleSelectReturnItems(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
pRequest
- the servlet's requestpResponse
- the servlet's responsejavax.servlet.ServletException
- if there was an error while executing the codejava.io.IOException
- if there was an error with servlet iopublic void selectReturnItems(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) throws java.io.IOException, javax.servlet.ServletException
java.io.IOException
javax.servlet.ServletException
public java.lang.String getTicketId()
public void preStartReturnProcess(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
pRequest
- a value of type 'DynamoHttpServletRequest'pResponse
- a value of type 'DynamoHttpServletResponse'javax.servlet.ServletException
- if an error occursjava.io.IOException
- if an error occurspublic void postStartReturnProcess(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
pRequest
- a value of type 'DynamoHttpServletRequest'pResponse
- a value of type 'DynamoHttpServletResponse'javax.servlet.ServletException
- if an error occursjava.io.IOException
- if an error occurspublic boolean handleStartReturnProcess(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
This method sets ReturnRequest.processName
property to "Return" and apply ReturnItems and
suggested amounts. If there is any replacement order is associated with the current request, then this method
removes the replacement order from the repository and from the request. In addition to the above, this method
calls ReturnManager.buildRefundMethodList to generate a list of payment groups which were part of the original
order.
pRequest
- the servlet's requestpResponse
- the servlet's responsejavax.servlet.ServletException
- if there was an error while executing the codejava.io.IOException
- if there was an error with servlet iopublic void startReturnProcess(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
This method sets ReturnRequest.processName
property to "Return" and apply ReturnItems and
suggested amounts. If there is any replacement order is associated with the current request, then this method
removes the replacement order from the repository and from the request. In addition to the above, this method
calls ReturnManager.buildRefundMethodList to generate a list of payment groups which were part of the original
order.
pRequest
- the servlet's requestpResponse
- the servlet's responsejavax.servlet.ServletException
- if there was an error while executing the codejava.io.IOException
- if there was an error with servlet iopublic void preStartExchangeProcess(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
pRequest
- a value of type 'DynamoHttpServletRequest'pResponse
- a value of type 'DynamoHttpServletResponse'javax.servlet.ServletException
- if an error occursjava.io.IOException
- if an error occurspublic void postStartExchangeProcess(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
pRequest
- a value of type 'DynamoHttpServletRequest'pResponse
- a value of type 'DynamoHttpServletResponse'javax.servlet.ServletException
- if an error occursjava.io.IOException
- if an error occurspublic boolean handleStartExchangeProcess(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
This method sets the ReturnRequest.processName
property to "Exchange" and apply ReturnItems
and suggested amounts. This method creates replacement orders (if there is not one already available).
Also the replacement order becomes the current order.
pRequest
- the servlet's requestpResponse
- the servlet's responsejavax.servlet.ServletException
- if there was an error while executing the codejava.io.IOException
- if there was an error with servlet iopublic void startExchangeProcess(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
This method sets the ReturnRequest.processName
property to "Exchange" and apply ReturnItems
and suggested amounts. This method creates replacement orders (if there is not one already available).
Also the replacement order becomes the current order.
pRequest
- the servlet's requestpResponse
- the servlet's responsejavax.servlet.ServletException
- if there was an error while executing the codejava.io.IOException
- if there was an error with servlet iopublic void loadReplacementOrder(atg.commerce.csr.returns.ReturnRequest pReturnRequest) throws atg.commerce.csr.returns.ReturnException
pReturnRequest
- ReturnException
public atg.commerce.csr.returns.ReturnsDataHolder getReturnsDataHolder()
public void runProcessValidatePaymentGroups(atg.commerce.order.Order pOrder, java.util.Locale pLocale, java.util.Map pExtraParameters) throws atg.service.pipeline.RunProcessException
runProcessValidatePaymentGroups
runs a configurable Pipeline chain
to validate PaymentGroups or to prepare for the next checkout phase.pOrder
- an Order
valuepLocale
- a Locale
valuepExtraParameters
- a Map
valueatg.service.pipeline.RunProcessException
- if an error occurspublic void createNewOrder()
EnvironmentTools
and creates new order.
Also this method sets the new order progress bar.public void postSelectItemsAndStartReturn(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
pRequest
- a value of type 'DynamoHttpServletRequest'pResponse
- a value of type 'DynamoHttpServletResponse'javax.servlet.ServletException
- if an error occursjava.io.IOException
- if an error occurspublic void preConfirmReturn(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
preConfirmReturn
in class atg.commerce.csr.returns.BaseReturnFormHandler
pRequest
- a value of type 'DynamoHttpServletRequest'pResponse
- a value of type 'DynamoHttpServletResponse'javax.servlet.ServletException
- if an error occursjava.io.IOException
- if an error occursprotected java.util.Map generateConfirmExtraParameters()
generateConfirmExtraParameters
in class atg.commerce.csr.returns.BaseReturnFormHandler
public void applyRefunds(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
applyRefunds
in class atg.commerce.csr.returns.BaseReturnFormHandler
pRequest
- the servlet's requestpResponse
- the servlet's responsejavax.servlet.ServletException
- if there was an error while executing the codejava.io.IOException
- if there was an error with servlet ioPaymentGroupManager.recalculatePaymentGroupAmounts(Order)
,
PaymentGroupManager.removeEmptyPaymentGroups(Order)
,
runProcessValidatePaymentGroups(Order, Locale, Map)
public void postCancelReturnRequest(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
postCancelReturnRequest
in class atg.commerce.csr.returns.BaseReturnFormHandler
pRequest
- a value of type 'DynamoHttpServletRequest'pResponse
- a value of type 'DynamoHttpServletResponse'javax.servlet.ServletException
- if an error occursjava.io.IOException
- if an error occursprotected java.util.Map generateCreateReturnRequestExtraParameters()
generateCreateReturnRequestExtraParameters
in class atg.commerce.csr.returns.BaseReturnFormHandler
public void postSelectItems(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
postSelectItems
in class atg.commerce.csr.returns.BaseReturnFormHandler
pRequest
- a value of type 'DynamoHttpServletRequest'pResponse
- a value of type 'DynamoHttpServletResponse'javax.servlet.ServletException
- if an error occursjava.io.IOException
- if an error occurspublic void selectItemsAndStartReturn(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) throws java.io.IOException, javax.servlet.ServletException
pRequest
- pResponse
- java.io.IOException
javax.servlet.ServletException
ReturnManager.applySelectedItems(ReturnRequest, ProcessName, Map)
public void preSelectItemsAndStartReturn(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
pRequest
- a value of type 'DynamoHttpServletRequest'pResponse
- a value of type 'DynamoHttpServletResponse'javax.servlet.ServletException
- if an error occursjava.io.IOException
- if an error occurspublic boolean handleSelectItemsAndStartReturn(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
pRequest
- pResponse
- javax.servlet.ServletException
java.io.IOException
selectItemsAndStartReturn(DynamoHttpServletRequest, DynamoHttpServletResponse)
protected java.util.Map generateSelectItemsAndStartReturnExtraParameters()
protected java.util.Map generateSelectItemsExtraParameters()
generateSelectItemsExtraParameters
in class atg.commerce.csr.returns.BaseReturnFormHandler
protected void validateSelectedItems(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) throws javax.servlet.ServletException, java.io.IOException
pRequest
- pResponse
- javax.servlet.ServletException
java.io.IOException