atg.commerce.csr.order

Class CSRShippingGroupFormHandler

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.droplet.EmptyFormHandler

atg.droplet.GenericFormHandler

atg.commerce.order.purchase.PurchaseProcessFormHandler

atg.commerce.order.purchase.ShippingGroupFormHandler

atg.commerce.csr.order.CSRShippingGroupFormHandler

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 CSRShippingGroupFormHandler
extends atg.commerce.order.purchase.ShippingGroupFormHandler

The CSRShippingGroupFormHandler adds audit-logging capabilities to the ShippingGroupFormHandler

See Also:

ShippingGroupFormHandler

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION
static java.lang.String	COULD_NOT_ADD_SHIPPING_GROUP
static java.lang.String	ERROR_WHILE_APPLYING_EXCG_ORDER_PMTS
static java.lang.String	ERROR_WHILE_FETCHING_PRICE_LIST
static java.lang.String	ERROR_WHILE_PERSISTING_ORDER
static java.lang.String	ERROR_WHILE_REPRICING_ORDER
static java.lang.String	JSON_ERROR_ATTRIBUTE
protected boolean	mAddNewAddress
protected CSRAgentMessagingTools	mAgentMessagingTools
protected java.lang.String	mApplyShippingMethodsErrorURL
protected java.lang.String	mApplyShippingMethodsSuccessURL
protected boolean	mAuthorizedRecipientForInStorePickupRequired
protected java.lang.String	mCompleteOrderPageURL
protected CSRCreateHardgoodShippingGroupFormHandler	mCreateHardgoodShippingGroupFormHandler
protected CSRAgentTools	mCSRAgentTools
protected java.lang.String	mModifyOrderPricingOp
protected java.lang.String	mMultipleShippingGroupCheckoutErrorURL
protected java.lang.String	mMultipleShippingGroupCheckoutSuccessURL
protected java.lang.String	mNewAddressNickname
protected boolean	mPersistOrder
protected java.lang.String	mPostApplyShippingGroupsPricingOp
protected java.lang.String	mRefundMethodsPageURL
protected atg.commerce.csr.returns.ReturnManager	mReturnManager
static java.lang.String	MSG_ERROR_APPLYING_SHIPPING_GROUP
static java.lang.String	MSG_ERROR_DURING_PAYMENT_GROUPS_VALIDATION
static java.lang.String	MSG_ERROR_SAVING_SHIPPING_INFO
static java.lang.String	MSG_ERROR_VALIDATING_SHIPPING_INFO
protected java.lang.String	mShippingMethod
protected java.lang.String	mShippingMethodURL
protected java.lang.String	mShipToAddressNickname
protected java.lang.String	mSingleShippingGroupCheckoutErrorURL
protected java.lang.String	mSingleShippingGroupCheckoutSuccessURL
protected atg.commerce.pricing.PricingModelHolder	mSubmittedOrderPricingModels
static java.lang.String	MY_RESOURCE_NAME
static java.lang.String	NON_AUTHORIZED_RECIPIENT_OF_INSTORE_PICKUP_SHIPPING_GROUP
static java.lang.String	NULL_SHIPPING_GROUP_NAME

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

mAllHardgoodCommerceItemShippingInfos, mAllInStorePickupCommerceItemShippingInfos, mCommerceItemShippingInfoTools, mConsolidateShippingInfosBeforeApply, mElectronicShippingGroups, MSG_ERROR_UPDATE_SHIPPINGGROUP, MSG_INVALID_SHIPPING_SPLIT_NUMBER, MSG_INVALID_SHIPPING_SPLIT_NUMBER_WITH_FRACTION, MSG_NO_DEFAULT_SHIPPING_GROUP, mValidateShippingGroups

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

Method Summary

Modifier and Type	Method and Description
void	addShippingGroupValidationErrors(java.util.Collection pFormExceptions) Deprecated. -- This method is not used anymore. The shipping address page is totally changed and the shipping address page does not have an option to add address and move to the next checkout stage.
java.lang.String	applyExchangeProcessPayments(java.lang.String pHandlerSuccessURL) This method calls ReturnManager.applyExchangeProcessPayments(ReturnRequest) and applies the payment between the original order and replacement order.
void	applyShippingMethods(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) applyShippingMethods is used in the multiple shipping functionality.
protected void	changeShippingGroupForCommerceItemShippingInfos(java.util.Collection pCommerceItemShippingInfos, java.lang.String pShippingGroupName, java.lang.String pShippingMethod) Changes the shipping group name for a collection of items in the CommerceItemShippingInfoContainer
protected java.util.Map	createRepriceParameterMap() Creates the extra parameter map for pricing the order after form handler modifications.
protected java.lang.String	findShippingAddressDestinationURL() This method is used find the destination URL in the single and multiple shipping pages.
protected java.lang.String	findShippingMethodDestinationURL() This method is used find the destination URL in the shipping method page.
CSRAgentMessagingTools	getAgentMessagingTools() Returns component for sending agent messages
java.lang.String	getApplyShippingMethodsErrorURL() Returns the applyShippingMethodsErrorURL
java.lang.String	getApplyShippingMethodsSuccessURL() Returns the applyShippingMethodsSuccessURL
java.lang.String	getCompleteOrderPageURL() Returns the completeOrderPageURL.
CSRCreateHardgoodShippingGroupFormHandler	getCreateHardgoodShippingGroupFormHandler() Returns the createHardgoodShippingGroupFormHandler
CSRAgentTools	getCSRAgentTools()
java.lang.String	getInStorePickupShippingGroupType() Return the InStorePickupShippingGroupType property.
java.lang.String	getModifyOrderPricingOp() Returns the pricing operation that should be performed when the order is updated
java.lang.String	getMultipleShippingGroupCheckoutErrorURL() Returns the multipleShippingGroupCheckoutErrorURL
java.lang.String	getMultipleShippingGroupCheckoutSuccessURL() Return the multipleShippingGroupCheckoutSuccessURL
java.lang.String	getNewAddressNickname() Deprecated.
java.lang.String	getPostApplyShippingGroupsPricingOp() Returns the pricing operation used after apply shipping groups
java.lang.String	getRefundMethodsPageURL() Returns the refundMethodsPageURL.
atg.commerce.csr.returns.ReturnManager	getReturnManager() Returns the returnManager.
atg.commerce.order.ShippingGroupManager	getShippingGroupManager() Return the ShippingGroupManager property.
java.lang.String	getShippingMethod() Returns the shippingMethod
java.lang.String	getShippingMethodURL() Returns the shippingMethodURL
java.lang.String	getShipToAddressNickname() Returns the shipToAddressNickname
java.lang.String	getSingleShippingGroupCheckoutErrorURL() Returns the singleShippingGroupCheckoutErrorURL
java.lang.String	getSingleShippingGroupCheckoutSuccessURL() Returns the singleShippingGroupCheckoutSuccessURL
atg.commerce.pricing.PricingModelHolder	getSubmittedOrderPricingModels() Returns property SubmittedOrderPricingModels
java.lang.String	getTicketId() Returns the Id of the current ticket
atg.commerce.pricing.PricingModelHolder	getUserPricingModels() Returns the PricingModelHolder that should be used for the current order.
boolean	handleApplyShippingMethods(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) This method is used in the multiple shipping functionality.
boolean	handleMultipleShippingGroupCheckout(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) This method is specifically used to check out with multiple shipping address.
boolean	handlePreserveUserInputOnServerSide(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) This method is used to preserve any user inputs in the server's memory.
boolean	handleSingleShippingGroupCheckout(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) This method is specifically used to check out with single shipping address.
boolean	isAddNewAddress() Deprecated.
boolean	isAuthorizedRecipientForInStorePickupRequired() Returns authorizedRecipientForInStorePickupRequired
boolean	isMultipleNonGiftHardgoodItems() Determines if the total quantity of all non-gift hardgood items is more than one.
boolean	isPersistOrder() Returns the persistOrder
void	multipleShippingGroupCheckout(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) This method just calls ShippingGroupFormHandler.handleApplyShippingGroups
void	postApplyShippingGroups(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) postApplyShippingGroups is for work that must happen after the ShippingGroups are applied.
void	postApplyShippingMethods(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) postApplyShippingMethods is for work that must happen after the user selections are saved.
void	postMultipleShippingGroupCheckout(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) This method is used for Multiple ShippingGroupCheckout post processing.
void	postPreserveUserInputOnServerSide(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) postPreserveUserInputOnServerSide is for work that must happen after the user selections are saved.
void	postSingleShippingGroupCheckout(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) This method is used for ShippingGroupCheckout post processing.
void	preApplyShippingGroups(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) preApplyShippingGroups is for work that must happen before the ShippingGroups are applied.
void	preApplyShippingMethods(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) preApplyShippingMethods is for work that must happen before the user selections are retained.
void	preMultipleShippingGroupCheckout(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) This method is used for Multiple Shipping Group Checkout pre processing.
void	prePreserveUserInputOnServerSide(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) prePreserveUserInputOnServerSide is for work that must happen before the user selections are retained.
void	preSingleShippingGroupCheckout(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) This method is used for ShippingGroupCheckout pre processing.
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	setAddNewAddress(boolean pAddNewAddress) Deprecated.
void	setAgentMessagingTools(CSRAgentMessagingTools pAgentMessagingTools) Sets the component for sending agent messages
void	setApplyShippingMethodsErrorURL(java.lang.String pApplyShippingMethodsErrorURL) Sets the applyShippingMethodsErrorURL
void	setApplyShippingMethodsSuccessURL(java.lang.String pApplyShippingMethodsSuccessURL) Sets the applyShippingMethodsSuccessURL
void	setAuthorizedRecipientForInStorePickupRequired(boolean pAuthorizedRecipientForInStorePickupRequired) Sets authorizedRecipientForInStorePickupRequired
void	setCompleteOrderPageURL(java.lang.String pCompleteOrderPageURL) Sets the completeOrderPageURL.
void	setCreateHardgoodShippingGroupFormHandler(CSRCreateHardgoodShippingGroupFormHandler pCreateHardgoodShippingGroupFormHandler) Sets the createHardgoodShippingGroupFormHandler
void	setCSRAgentTools(CSRAgentTools pCSRAgentTools) Sets the property CSRAgentTools.
void	setInStorePickupShippingGroupType(java.lang.String pInStorePickupShippingGroupType) Set the InStorePickupShippingGroupType property.
void	setModifyOrderPricingOp(java.lang.String pModifyOrderPricingOp) This property should be set to the type of pricing operation that should be executed when the order is updated without adding or removing an item (e.g.
void	setMultipleShippingGroupCheckoutErrorURL(java.lang.String pMultipleShippingGroupCheckoutErrorURL) Sets the multipleShippingGroupCheckoutErrorURL
void	setMultipleShippingGroupCheckoutSuccessURL(java.lang.String pMultipleShippingGroupCheckoutSuccessURL) Sets the multipleShippingGroupCheckoutSuccessURL
void	setNewAddressNickname(java.lang.String pNewAddressNickname) Deprecated.
void	setPersistOrder(boolean pPersistOrder) Sets the persistOrder
void	setPostApplyShippingGroupsPricingOp(java.lang.String pPostApplyShippingGroupsPricingOp)
void	setRefundMethodsPageURL(java.lang.String pRefundMethodsPageURL) Sets the refundMethodsPageURL.
void	setReturnManager(atg.commerce.csr.returns.ReturnManager pReturnManager) Sets the returnManager.
void	setShippingGroupManager(atg.commerce.order.ShippingGroupManager pShippingGroupManager) Set the ShippingGroupManager property.
void	setShippingMethod(java.lang.String pShippingMethod) Sets the shippingMethod
void	setShippingMethodURL(java.lang.String pShippingMethodURL) Sets the shippingMethodURL
void	setShipToAddressNickname(java.lang.String pShipToAddressNickname) Sets the shipToAddressNickname
void	setSingleShippingGroupCheckoutErrorURL(java.lang.String pSingleShippingGroupCheckoutErrorURL) Sets the singleShippingGroupCheckoutErrorURL
void	setSingleShippingGroupCheckoutSuccessURL(java.lang.String pSingleShippingGroupCheckoutSuccessURL) Sets the singleShippingGroupCheckoutSuccessURL
void	setSubmittedOrderPricingModels(atg.commerce.pricing.PricingModelHolder pSubmittedOrderPricingModels) Sets property SubmittedOrderPricingModels
void	singleShippingGroupCheckout(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) In CSC application the shipping address page is used for selecting appropriate shipping groups for all commerce items.
protected void	splitCommerceItemShippingInfoByQuantity(atg.commerce.order.purchase.CommerceItemShippingInfo pCommerceItemShippingInfo, long pSplitQuantity) splitCommerceItemShippingInfoByQuantity extends the corresponding method in ShippingGroupFormHandler.

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

addShippingGroupToMap, applyCommerceItemShippingInfo, applyDefaultShippingGroup, applyShippingGroups, consolidateShippingInfos, getAllHardgoodCommerceItemShippingInfos, getAllInStorePickupCommerceItemShippingInfos, getApplyShippingGroupsErrorURL, getApplyShippingGroupsSuccessURL, getCommerceItemShippingInfoTools, getCurrentList, getCurrentShippingGroup, getDefaultShippingGroupName, getElectronicShippingGroups, getFirstNonGiftHardgoodShippingGroupWithRels, getGiftShippingGroups, getListId, getLocale, getNonGiftHardgoodShippingGroupCount, getNonGiftHardgoodShippingGroups, getShippingGroup, getShippingGroupId, getShippingGroupInitializers, getSpecifyDefaultShippingGroupErrorURL, getSpecifyDefaultShippingGroupSuccessURL, getSplitShippingInfosErrorURL, getSplitShippingInfosSuccessURL, getValidateShippingGroupsChainId, handleApplyShippingGroups, handleSpecifyDefaultShippingGroup, handleSplitShippingInfos, isAnyElectronicShippingGroups, isAnyHardgoodShippingGroups, isAnyNonGiftHardgoodShippingGroups, isApplyDefaultShippingGroup, isConsolidateShippingInfosBeforeApply, isMultipleHardgoodShippingGroupsWithRelationships, isMultipleNonGiftHardgoodShippingGroups, isShippingGroupInOrder, isValidateShippingGroups, mergeCommerceItemShippingInfos, postSpecifyDefaultShippingGroup, postSplitShippingInfos, preSpecifyDefaultShippingGroup, preSplitShippingInfos, removeShippingGroupFromMap, runProcessValidateShippingGroups, setApplyDefaultShippingGroup, setApplyShippingGroupsErrorURL, setApplyShippingGroupsSuccessURL, setCommerceItemShippingInfoTools, setConsolidateShippingInfosBeforeApply, setCurrentList, setCurrentShippingGroup, setDefaultShippingGroupName, setListId, setLocale, setShippingGroupId, setShippingGroupInitializers, setSpecifyDefaultShippingGroupErrorURL, setSpecifyDefaultShippingGroupSuccessURL, setSplitShippingInfosErrorURL, setSplitShippingInfosSuccessURL, setValidateShippingGroups, setValidateShippingGroupsChainId, specifyDefaultShippingGroup, splitShippingInfos

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

acquireTransactionLock, acquireTransactionLock, afterSet, beforeSet, checkFormRedirect, commitTransaction, copyConfiguration, 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, getShippingGroupMapContainer, getShoppingCart, getTransactionManager, getUserLocale, getUserLocale, 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, setShippingGroupMapContainer, setShoppingCart, setTransactionCreated, setTransactionManager, 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, clearAbsoluteNameAndContext, createAdminServlet, doStopService, getAbsoluteName, getAdminServlet, getAdminServletOutputStreamEncoding, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isAdminServletUseServletOutputStream, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, isStartServiceComplete, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, reResolveThis, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setAdminServletOutputStreamEncoding, setAdminServletUseServletOutputStream, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService, toString

Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

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

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static final java.lang.String CLASS_VERSION

See Also:

Constant Field Values

MY_RESOURCE_NAME

public static final java.lang.String MY_RESOURCE_NAME

See Also:

Constant Field Values

JSON_ERROR_ATTRIBUTE

public static final java.lang.String JSON_ERROR_ATTRIBUTE

See Also:

Constant Field Values

MSG_ERROR_APPLYING_SHIPPING_GROUP

public static final java.lang.String MSG_ERROR_APPLYING_SHIPPING_GROUP

See Also:

Constant Field Values

COULD_NOT_ADD_SHIPPING_GROUP

public static final java.lang.String COULD_NOT_ADD_SHIPPING_GROUP

See Also:

Constant Field Values

NULL_SHIPPING_GROUP_NAME

public static final java.lang.String NULL_SHIPPING_GROUP_NAME

See Also:

Constant Field Values

NON_AUTHORIZED_RECIPIENT_OF_INSTORE_PICKUP_SHIPPING_GROUP

public static final java.lang.String NON_AUTHORIZED_RECIPIENT_OF_INSTORE_PICKUP_SHIPPING_GROUP

See Also:

Constant Field Values

ERROR_WHILE_PERSISTING_ORDER

public static final java.lang.String ERROR_WHILE_PERSISTING_ORDER

See Also:

Constant Field Values

ERROR_WHILE_REPRICING_ORDER

public static final java.lang.String ERROR_WHILE_REPRICING_ORDER

See Also:

Constant Field Values

ERROR_WHILE_FETCHING_PRICE_LIST

public static final java.lang.String ERROR_WHILE_FETCHING_PRICE_LIST

See Also:

Constant Field Values

ERROR_WHILE_APPLYING_EXCG_ORDER_PMTS

public static final java.lang.String ERROR_WHILE_APPLYING_EXCG_ORDER_PMTS

See Also:

Constant Field Values

MSG_ERROR_DURING_PAYMENT_GROUPS_VALIDATION

public static final java.lang.String MSG_ERROR_DURING_PAYMENT_GROUPS_VALIDATION

See Also:

Constant Field Values

MSG_ERROR_SAVING_SHIPPING_INFO

public static final java.lang.String MSG_ERROR_SAVING_SHIPPING_INFO

See Also:

Constant Field Values

MSG_ERROR_VALIDATING_SHIPPING_INFO

public static final java.lang.String MSG_ERROR_VALIDATING_SHIPPING_INFO

See Also:

Constant Field Values

mSingleShippingGroupCheckoutErrorURL

protected java.lang.String mSingleShippingGroupCheckoutErrorURL

mSingleShippingGroupCheckoutSuccessURL

protected java.lang.String mSingleShippingGroupCheckoutSuccessURL

mMultipleShippingGroupCheckoutSuccessURL

protected java.lang.String mMultipleShippingGroupCheckoutSuccessURL

mMultipleShippingGroupCheckoutErrorURL

protected java.lang.String mMultipleShippingGroupCheckoutErrorURL

mCreateHardgoodShippingGroupFormHandler

protected CSRCreateHardgoodShippingGroupFormHandler mCreateHardgoodShippingGroupFormHandler

mShippingMethod

protected java.lang.String mShippingMethod

mPersistOrder

protected boolean mPersistOrder

mAuthorizedRecipientForInStorePickupRequired

protected boolean mAuthorizedRecipientForInStorePickupRequired

mApplyShippingMethodsSuccessURL

protected java.lang.String mApplyShippingMethodsSuccessURL

mApplyShippingMethodsErrorURL

protected java.lang.String mApplyShippingMethodsErrorURL

mCompleteOrderPageURL

protected java.lang.String mCompleteOrderPageURL

mRefundMethodsPageURL

protected java.lang.String mRefundMethodsPageURL

mShippingMethodURL

protected java.lang.String mShippingMethodURL

mReturnManager

protected atg.commerce.csr.returns.ReturnManager mReturnManager

mPostApplyShippingGroupsPricingOp

protected java.lang.String mPostApplyShippingGroupsPricingOp

mModifyOrderPricingOp

protected java.lang.String mModifyOrderPricingOp

mSubmittedOrderPricingModels

protected atg.commerce.pricing.PricingModelHolder mSubmittedOrderPricingModels

mCSRAgentTools

protected CSRAgentTools mCSRAgentTools

mAgentMessagingTools

protected CSRAgentMessagingTools mAgentMessagingTools

mAddNewAddress

protected boolean mAddNewAddress

mShipToAddressNickname

protected java.lang.String mShipToAddressNickname

mNewAddressNickname

protected java.lang.String mNewAddressNickname

Constructor Detail

CSRShippingGroupFormHandler

public CSRShippingGroupFormHandler()

Method Detail

getPostApplyShippingGroupsPricingOp

public java.lang.String getPostApplyShippingGroupsPricingOp()

Returns the pricing operation used after apply shipping groups

Default is PricingConstants.OP_REPRICE_ORDER_TOTAL

Returns:

String

setPostApplyShippingGroupsPricingOp

public void setPostApplyShippingGroupsPricingOp(java.lang.String pPostApplyShippingGroupsPricingOp)

getCompleteOrderPageURL

public java.lang.String getCompleteOrderPageURL()

Returns the completeOrderPageURL.

Returns:

completeOrderPageURL

setCompleteOrderPageURL

public void setCompleteOrderPageURL(java.lang.String pCompleteOrderPageURL)

Sets the completeOrderPageURL.

Parameters:

pCompleteOrderPageURL -

getRefundMethodsPageURL

public java.lang.String getRefundMethodsPageURL()

Returns the refundMethodsPageURL.

Returns:

refundMethodsPageURL

setRefundMethodsPageURL

public void setRefundMethodsPageURL(java.lang.String pRefundMethodsPageURL)

Sets the refundMethodsPageURL.

Parameters:

pRefundMethodsPageURL -

getReturnManager

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

Returns the returnManager.

Returns:

returnManager

setReturnManager

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

Sets the returnManager.

Parameters:

pReturnManager -

getApplyShippingMethodsErrorURL

public java.lang.String getApplyShippingMethodsErrorURL()

Returns the applyShippingMethodsErrorURL

Returns:

the applyShippingMethodsErrorURL

setApplyShippingMethodsErrorURL

public void setApplyShippingMethodsErrorURL(java.lang.String pApplyShippingMethodsErrorURL)

Sets the applyShippingMethodsErrorURL

Parameters:

pApplyShippingMethodsErrorURL - The applyShippingMethodsErrorURL to set.

getApplyShippingMethodsSuccessURL

public java.lang.String getApplyShippingMethodsSuccessURL()

Returns the applyShippingMethodsSuccessURL

Returns:

the applyShippingMethodsSuccessURL

setApplyShippingMethodsSuccessURL

public void setApplyShippingMethodsSuccessURL(java.lang.String pApplyShippingMethodsSuccessURL)

Sets the applyShippingMethodsSuccessURL

Parameters:

pApplyShippingMethodsSuccessURL - The applyShippingMethodsSuccessURL to set.

isPersistOrder

public boolean isPersistOrder()

Returns the persistOrder

Returns:

the persistOrder

setPersistOrder

public void setPersistOrder(boolean pPersistOrder)

Sets the persistOrder

Parameters:

pPersistOrder - The persistOrder to set.

isAuthorizedRecipientForInStorePickupRequired

public boolean isAuthorizedRecipientForInStorePickupRequired()

Returns authorizedRecipientForInStorePickupRequired

Returns:

authorizedRecipientForInStorePickupRequired

setAuthorizedRecipientForInStorePickupRequired

public void setAuthorizedRecipientForInStorePickupRequired(boolean pAuthorizedRecipientForInStorePickupRequired)

Sets authorizedRecipientForInStorePickupRequired

Parameters:

pAuthorizedRecipientForInStorePickupRequired -

getSingleShippingGroupCheckoutErrorURL

public java.lang.String getSingleShippingGroupCheckoutErrorURL()

Returns the singleShippingGroupCheckoutErrorURL

Returns:

Returns the singleShippingGroupCheckoutErrorURL.

setSingleShippingGroupCheckoutErrorURL

public void setSingleShippingGroupCheckoutErrorURL(java.lang.String pSingleShippingGroupCheckoutErrorURL)

Sets the singleShippingGroupCheckoutErrorURL

Parameters:

pSingleShippingGroupCheckoutErrorURL - The singleShippingGroupCheckoutErrorURL to set.

getSingleShippingGroupCheckoutSuccessURL

public java.lang.String getSingleShippingGroupCheckoutSuccessURL()

Returns the singleShippingGroupCheckoutSuccessURL

Returns:

Returns the singleShippingGroupCheckoutSuccessURL.

setSingleShippingGroupCheckoutSuccessURL

public void setSingleShippingGroupCheckoutSuccessURL(java.lang.String pSingleShippingGroupCheckoutSuccessURL)

Sets the singleShippingGroupCheckoutSuccessURL

Parameters:

pSingleShippingGroupCheckoutSuccessURL - The singleShippingGroupCheckoutSuccessURL to set.

getCreateHardgoodShippingGroupFormHandler

public CSRCreateHardgoodShippingGroupFormHandler getCreateHardgoodShippingGroupFormHandler()

Returns the createHardgoodShippingGroupFormHandler

Returns:

Returns the createHardgoodShippingGroupFormHandler.

setCreateHardgoodShippingGroupFormHandler

public void setCreateHardgoodShippingGroupFormHandler(CSRCreateHardgoodShippingGroupFormHandler pCreateHardgoodShippingGroupFormHandler)

Sets the createHardgoodShippingGroupFormHandler

Parameters:

pCreateHardgoodShippingGroupFormHandler - The createHardgoodShippingGroupFormHandler to set.

getShippingMethod

public java.lang.String getShippingMethod()

Returns the shippingMethod

Returns:

Returns the shippingMethod.

setShippingMethod

public void setShippingMethod(java.lang.String pShippingMethod)

Sets the shippingMethod

Parameters:

pShippingMethod - The shippingMethod to set.

setModifyOrderPricingOp

public void setModifyOrderPricingOp(java.lang.String pModifyOrderPricingOp)

This property should be set to the type of pricing operation that should be executed when the order is updated without adding or removing an item (e.g. quantity change). The operations which are acceptable are defined in the atg.commerce.pricing.PricingConstants interface. They include:

• PricingConstants.OP_REPRICE_ORDER_TOTAL -> ORDER_TOTAL
• PricingConstants.OP_REPRICE_ORDER_SUBTOTAL -> ORDER_SUBTOTAL
• PricingConstants.OP_REPRICE_ORDER_SUBTOTAL_SHIPPING -> ORDER_SUBTOTAL_SHIPPING
• PricingConstants.OP_REPRICE_ORDER_SUBTOTAL_TAX -> ORDER_SUBTOTAL_TAX
• PricingConstants.OP_REPRICE_ITEMS -> ITEMS
• PricingConstants.OP_REPRICE_SHIPPING -> SHIPPING
• PricingConstants.OP_REPRICE_ORDER -> ORDER
• PricingConstants.OP_REPRICE_TAX -> TAX
• PricingConstants.OP_NO_REPRICE -> NO_REPRICE

If this value is null, then the system will default to ORDER_TOTAL.

Parameters:

pModifyOrderPricingOp - a String value

getModifyOrderPricingOp

public java.lang.String getModifyOrderPricingOp()

Returns the pricing operation that should be performed when the order is updated

Returns:

a String value

setShippingGroupManager

public void setShippingGroupManager(atg.commerce.order.ShippingGroupManager pShippingGroupManager)

Set the ShippingGroupManager property.

Overrides:

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

Parameters:

pShippingGroupManager - a ShippingGroupManager value

getShippingGroupManager

public atg.commerce.order.ShippingGroupManager getShippingGroupManager()

Return the ShippingGroupManager property.

Overrides:

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

Returns:

a ShippingGroupManager value

setInStorePickupShippingGroupType

public void setInStorePickupShippingGroupType(java.lang.String pInStorePickupShippingGroupType)

Set the InStorePickupShippingGroupType property.

Parameters:

pInStorePickupShippingGroupType - a String value

getInStorePickupShippingGroupType

public java.lang.String getInStorePickupShippingGroupType()

Return the InStorePickupShippingGroupType property.

Returns:

a String value

getUserPricingModels

public atg.commerce.pricing.PricingModelHolder getUserPricingModels()

Returns the PricingModelHolder that should be used for the current order.

Overrides:

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

Returns:

a PricingModelHolder value

See Also:

CSREnvironmentTools.getOrderPricingModelHolder(Order)

setSubmittedOrderPricingModels

public void setSubmittedOrderPricingModels(atg.commerce.pricing.PricingModelHolder pSubmittedOrderPricingModels)

Sets property SubmittedOrderPricingModels

Parameters:

pSubmittedOrderPricingModels - a SubmittedOrderPricingModels value

getSubmittedOrderPricingModels

public atg.commerce.pricing.PricingModelHolder getSubmittedOrderPricingModels()

Returns property SubmittedOrderPricingModels

Returns:

a SubmittedOrderPricingModels value

setCSRAgentTools

public void setCSRAgentTools(CSRAgentTools pCSRAgentTools)

Sets the property CSRAgentTools.

getCSRAgentTools

public CSRAgentTools getCSRAgentTools()

Returns:

The value of the property CSRAgentTools.

setAgentMessagingTools

public void setAgentMessagingTools(CSRAgentMessagingTools pAgentMessagingTools)

Sets the component for sending agent messages

Parameters:

pAgentMessagingTools -

getAgentMessagingTools

public CSRAgentMessagingTools getAgentMessagingTools()

Returns component for sending agent messages

Returns:

AgentMessagingTools

setAddNewAddress

public void setAddNewAddress(boolean pAddNewAddress)

Deprecated.

Boolean indicating whether a new address is being added.

Parameters:

pAddNewAddress - boolean indicating whether a new address is being added

isAddNewAddress

public boolean isAddNewAddress()

Deprecated.

Returns:

boolean indicating whether a new address is being added

getShipToAddressNickname

public java.lang.String getShipToAddressNickname()

Returns the shipToAddressNickname

Returns:

Returns the shipToAddressNickname.

setShipToAddressNickname

public void setShipToAddressNickname(java.lang.String pShipToAddressNickname)

Sets the shipToAddressNickname

Parameters:

pShipToAddressNickname - The shipToAddressNickname to set.

getNewAddressNickname

public java.lang.String getNewAddressNickname()

Deprecated.

Returns the newAddressNickname

Returns:

Returns the newAddressNickname.

setNewAddressNickname

public void setNewAddressNickname(java.lang.String pNewAddressNickname)

Deprecated.

Sets the newAddressNickname

Parameters:

pNewAddressNickname - The newAddressNickname to set.

getTicketId

public java.lang.String getTicketId()

Returns the Id of the current ticket

getShippingMethodURL

public java.lang.String getShippingMethodURL()

Returns the shippingMethodURL

Returns:

the shippingMethodURL

setShippingMethodURL

public void setShippingMethodURL(java.lang.String pShippingMethodURL)

Sets the shippingMethodURL

Parameters:

pShippingMethodURL - the shippingMethodURL to set

getMultipleShippingGroupCheckoutSuccessURL

public java.lang.String getMultipleShippingGroupCheckoutSuccessURL()

Return the multipleShippingGroupCheckoutSuccessURL

Returns:

the multipleShippingGroupCheckoutSuccessURL

setMultipleShippingGroupCheckoutSuccessURL

public void setMultipleShippingGroupCheckoutSuccessURL(java.lang.String pMultipleShippingGroupCheckoutSuccessURL)

Sets the multipleShippingGroupCheckoutSuccessURL

Parameters:

pMultipleShippingGroupCheckoutSuccessURL - the multipleShippingGroupCheckoutSuccessURL to set

getMultipleShippingGroupCheckoutErrorURL

public java.lang.String getMultipleShippingGroupCheckoutErrorURL()

Returns the multipleShippingGroupCheckoutErrorURL

Returns:

the multipleShippingGroupCheckoutErrorURL

setMultipleShippingGroupCheckoutErrorURL

public void setMultipleShippingGroupCheckoutErrorURL(java.lang.String pMultipleShippingGroupCheckoutErrorURL)

Sets the multipleShippingGroupCheckoutErrorURL

Parameters:

pMultipleShippingGroupCheckoutErrorURL - the multipleShippingGroupCheckoutErrorURL to set

postApplyShippingGroups

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

postApplyShippingGroups is for work that must happen after the ShippingGroups are applied.

Overrides:

postApplyShippingGroups in class atg.commerce.order.purchase.ShippingGroupFormHandler

Parameters:

pRequest - a DynamoHttpServletRequest value

pResponse - a DynamoHttpServletResponse value

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs

splitCommerceItemShippingInfoByQuantity

protected void splitCommerceItemShippingInfoByQuantity(atg.commerce.order.purchase.CommerceItemShippingInfo pCommerceItemShippingInfo,
                                                       long pSplitQuantity)

splitCommerceItemShippingInfoByQuantity extends the corresponding method in ShippingGroupFormHandler. It will send a SplitShippingGroup event that will be captured by the audit-logging system

Overrides:

splitCommerceItemShippingInfoByQuantity in class atg.commerce.order.purchase.ShippingGroupFormHandler

Parameters:

pCommerceItemShippingInfo - a CommerceItemShippingInfo value

pSplitQuantity - a long value

preSingleShippingGroupCheckout

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

This method is used for ShippingGroupCheckout pre processing.

Parameters:

pRequest -

pResponse -

Throws:

javax.servlet.ServletException

java.io.IOException

handleSingleShippingGroupCheckout

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

This method is specifically used to check out with single shipping address.

Parameters:

pRequest -

pResponse -

Returns:

boolean

Throws:

javax.servlet.ServletException

java.io.IOException

postSingleShippingGroupCheckout

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

This method is used for ShippingGroupCheckout post processing.

Parameters:

pRequest -

pResponse -

Throws:

javax.servlet.ServletException

java.io.IOException

singleShippingGroupCheckout

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

In CSC application the shipping address page is used for selecting appropriate shipping groups for all commerce items. The shipping address page supports all shipping groups supported by the csc application.

Parameters:

pRequest -

pResponse -

Throws:

javax.servlet.ServletException

java.io.IOException

See Also:

ShippingGroupFormHandler.applyShippingGroups(DynamoHttpServletRequest, DynamoHttpServletResponse)

addShippingGroupValidationErrors

public void addShippingGroupValidationErrors(java.util.Collection pFormExceptions)

Deprecated. -- This method is not used anymore. The shipping address page is totally changed and the shipping address page does not have an option to add address and move to the next checkout stage.

The form errors are not added to the request. If the errors are added to request, then those errors will show up in the messaging UI

Parameters:

pFormExceptions -

See Also:

This method uses CreateHardgoodFormHandler to add a shipping group. but the error messages are not added to the request. This method adds the errors to the request.

changeShippingGroupForCommerceItemShippingInfos

protected void changeShippingGroupForCommerceItemShippingInfos(java.util.Collection pCommerceItemShippingInfos,
                                                               java.lang.String pShippingGroupName,
                                                               java.lang.String pShippingMethod)

Changes the shipping group name for a collection of items in the CommerceItemShippingInfoContainer

Parameters:

pCommerceItemShippingInfos - the collection of items to change

pShippingGroupName - if this is not null, each info item's shipping group name is set to this value

pShippingMethod - This parameter is not used.

handlePreserveUserInputOnServerSide

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

This method is used to preserve any user inputs in the server's memory. For example if an agent is in the multiple shipping page and the multiple shipping page has few drop downs and edit icon to edit an address. If the agent changes the values in the drop down and prefers to click on the edit icon to edit an address. The edit address action will refresh the multiple shipping page with current information (without the user's selection. because it is not saved in the server object). In order to retain the user information, they have to call this method to preserve the user input or selections. This method creates a json object and sends them in the response. The data or response receiving layer should understand text/json data stream.

Parameters:

pRequest -

pResponse -

Returns:

boolean

Throws:

javax.servlet.ServletException

java.io.IOException

prePreserveUserInputOnServerSide

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

prePreserveUserInputOnServerSide is for work that must happen before the user selections are retained.

Parameters:

pRequest - a DynamoHttpServletRequest value

pResponse - a DynamoHttpServletResponse value

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs

postPreserveUserInputOnServerSide

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

postPreserveUserInputOnServerSide is for work that must happen after the user selections are saved.

Parameters:

pRequest - a DynamoHttpServletRequest value

pResponse - a DynamoHttpServletResponse value

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs

handleApplyShippingMethods

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

This method is used in the multiple shipping functionality. This method allows us to save the user selected shipping methods for the shipping groups. In addition to that user's could save the order if is transient.

Parameters:

pRequest -

pResponse -

Returns:

boolean

Throws:

javax.servlet.ServletException

java.io.IOException

applyShippingMethods

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

applyShippingMethods is used in the multiple shipping functionality. This method allows us to save the user selected shipping methods for the shipping groups. In addition to that user's could save the order if is transient.

Parameters:

pRequest - a DynamoHttpServletRequest value

pResponse - a DynamoHttpServletResponse value

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs

preApplyShippingMethods

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

preApplyShippingMethods is for work that must happen before the user selections are retained.

Parameters:

pRequest - a DynamoHttpServletRequest value

pResponse - a DynamoHttpServletResponse value

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs

postApplyShippingMethods

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

postApplyShippingMethods is for work that must happen after the user selections are saved.

Parameters:

pRequest - a DynamoHttpServletRequest value

pResponse - a DynamoHttpServletResponse value

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs

createRepriceParameterMap

protected java.util.Map createRepriceParameterMap()

Creates the extra parameter map for pricing the order after form handler modifications.

Overrides:

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

Returns:

Map of parameters or null

See Also:

CSRAgentTools.addCurrentOrderPricingParameters(Map)

applyExchangeProcessPayments

public java.lang.String applyExchangeProcessPayments(java.lang.String pHandlerSuccessURL)

This method calls ReturnManager.applyExchangeProcessPayments(ReturnRequest) and applies the payment between the original order and replacement order. After applying the payments, this method provides the success urls.

Parameters:

pHandlerSuccessURL -

Returns:

String

runProcessValidatePaymentGroups

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.

Parameters:

pOrder - an Order value

pLocale - a Locale value

pExtraParameters - a Map value

Throws:

atg.service.pipeline.RunProcessException - if an error occurs

isMultipleNonGiftHardgoodItems

public boolean isMultipleNonGiftHardgoodItems()

Determines if the total quantity of all non-gift hardgood items is more than one.

Returns:

true if the the non-gift hg item quantity is more than one.

preApplyShippingGroups

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

preApplyShippingGroups is for work that must happen before the ShippingGroups are applied. This method is added to make sure the Shipping Group object references are same during the session fail over. In CSC, the ShippingGroupContainerService is loaded from Order, Profile and any newly added shipping groups. A shipping group which is loaded from the order could be used as one of the current shipping address. The same address could be updated in the shipping address page. In order to fix a session fail over issue, in case if a shipping group from an order is used, the shipping groups are copied from the order to fix the object references. If the shipping group from an order is used, the ShippingGroupContainer and Order should have same references. If the shipping group address is updated in the shipping address page, you need to make sure that the order's shipping group instance is also updated. Otherwise after session fail over, you will not see the address updates in the order's shipping groups.

Overrides:

preApplyShippingGroups in class atg.commerce.order.purchase.ShippingGroupFormHandler

Parameters:

pRequest - a DynamoHttpServletRequest value

pResponse - a DynamoHttpServletResponse value

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs

See Also:

UpdateHardgoodShippingGroupFormHandler.isUpdateOrder()

findShippingAddressDestinationURL

protected java.lang.String findShippingAddressDestinationURL()

This method is used find the destination URL in the single and multiple shipping pages.

Here is the page flow for the normal check out and exchange order. 1)Normal Checkout

• If there is any hard goods in the order, the shipping methods page URL is returned.
• If there is NO hard goods in the order, empty string is returned and the form handler's success url is used to serve the next page.

2) Exchange order checkout:

• If there is any hard goods in the order, the shipping methods page URL is returned.

If there is NO hard goods in the order, based on the balance amount between the return and exchange the following URL is returned.

• if the balance payment is due, empty string is returned and the form handler's success url is used to serve the next page.
• if the balance payment is refund, the refund type page URL is returned.
• if the balance payment is 0.00, the complete order page URL is returned.

If there is some additional requirements need to be met, this method could be extended to meet the needs.

Returns:

the url or page to serve.

See Also:

applyExchangeProcessPayments(String)

findShippingMethodDestinationURL

protected java.lang.String findShippingMethodDestinationURL()

This method is used find the destination URL in the shipping method page.

Here is the page flow for the normal check out and exchange order. 1)Normal Checkout

• empty string is returned and the form handler's success url is used to serve the next page.

2) Exchange order checkout:

• If there is any hard goods in the order, the shipping methods page URL is returned.

If there is NO hard goods in the order, based on the balance amount between the return and exchange the following URL is returned.

• if the balance payment is due, empty string is returned and the form handler's success url is used to serve the next page.
• if the balance payment is refund, the refund type page URL is returned.
• if the balance payment is 0.00, the complete order page URL is returned.

If there is some additional requirements need to be met, this method could be extended to meet the needs.

Returns:

the url or page to serve.

See Also:

applyExchangeProcessPayments(String)

preMultipleShippingGroupCheckout

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

This method is used for Multiple Shipping Group Checkout pre processing.

Parameters:

pRequest -

pResponse -

Throws:

javax.servlet.ServletException

java.io.IOException

handleMultipleShippingGroupCheckout

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

This method is specifically used to check out with multiple shipping address. This method is added to support dynamic checkout page flow. After selecting the shipping groups for the commerce items, the page has to decide which page to serve. Also this setup provides option to add any custom code for multiple shipping.

Parameters:

pRequest -

pResponse -

Returns:

boolean

Throws:

javax.servlet.ServletException

java.io.IOException

postMultipleShippingGroupCheckout

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

This method is used for Multiple ShippingGroupCheckout post processing.

Parameters:

pRequest -

pResponse -

Throws:

javax.servlet.ServletException

java.io.IOException

multipleShippingGroupCheckout

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

This method just calls ShippingGroupFormHandler.handleApplyShippingGroups

Parameters:

pRequest -

pResponse -

Throws:

javax.servlet.ServletException

java.io.IOException

See Also:

ShippingGroupFormHandler.handleApplyShippingGroups(DynamoHttpServletRequest, DynamoHttpServletResponse)