atg.projects.store.order.purchase
Class BillingInfoFormHandler

java.lang.Object
  atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      atg.nucleus.GenericService
          atg.droplet.EmptyFormHandler
              atg.droplet.GenericFormHandler
                  atg.commerce.order.purchase.PurchaseProcessFormHandler
                      atg.projects.store.order.purchase.BillingInfoFormHandler

All Implemented Interfaces:

atg.commerce.util.PipelineErrorHandler, atg.droplet.DropletFormHandler, atg.naming.NameContextBindingListener, atg.naming.NameContextElement, atg.naming.NameResolver, atg.nucleus.AdminableService, 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 BillingInfoFormHandler
extends atg.commerce.order.purchase.PurchaseProcessFormHandler

Form Handler for taking billing information.

Field Summary

static java.lang.String	CLASS_VERSION Class version string.
static java.lang.String	COUNTRY_KEY_PREFIX
static java.lang.String	COUNTRY_STATE_RESOURCES
protected java.lang.String	mBillingAddressNickname Billing Address nickname
protected atg.commerce.catalog.CatalogTools	mCatalogTools Catalog tools.
protected atg.core.util.ContactInfo	mCreditCardBillingAddress Credit card billing address
protected java.lang.String	mCreditCardExpirationMonth Credit card expiration month
protected java.lang.String	mCreditCardExpirationYear Credit card expiration year
protected java.lang.String	mCreditCardNickname Credit card nickname.
protected java.lang.String	mCreditCardNumber Credit card number
protected java.lang.String	mCreditCardType Credit card type
protected java.lang.String	mCreditCardVerificationNumber Property for holding the credit card verification number for a stored credit card.
protected java.lang.String	mEmail E-mail.
protected boolean	mEmailOptIn Is e-mail option turned in.
protected java.lang.String	mEmailOptInSourceCode E-mail option source code.
protected int	mMaxNickNameLength Maximum nickname length.
protected int	mMinNickNameLength Minimum nickname length.
protected java.lang.String	mMoveToConfirmationChainId Move to confirmation chain id.
protected java.lang.String	mMoveToConfirmErrorURL Move to confirm error redirect URL.
protected java.lang.String	mMoveToConfirmSuccessURL Move to confirm success redirect URL.
protected java.lang.String	mNewCreditCardVerificationNumber Property for holding the credit card verification number for a new credit card.
protected java.lang.String	mNewUserPassword New user password.
protected java.lang.String	mRegisterAccountErrorURL
protected java.lang.String	mRegisterAccountSuccessURL
protected java.lang.String	mRetypeNewPassword Retypes new password.
protected boolean	mSaveCreditCard Should save credit card data.
protected boolean	mSaveShippingInfo Should save shipping information.
protected static java.lang.String	MSG_ERROR_INCORRECT_STATE Error message for incorrect state
protected static java.lang.String	MSG_ERROR_MOVE_TO_CONFIRM Error while confirmation message key.
protected static java.lang.String	MSG_ERROR_UPDATE_ORDER Error updating order message key.
protected StoreConfiguration	mStoreConfiguration Store configuration.
protected java.lang.String	mStoredAddressSelection Stored address selection.
protected java.lang.String	mStoredCreditCardName Stores credit card name.
protected boolean	mUsingProfileCreditCard Is the credit card saved in the user's profile.
protected boolean	mUsingSavedAddress Is the address in the user's profile.
protected boolean	mUsingStoreCredit Is order covered with store credit only.
protected java.util.Map	mValue Property to hold profile values

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

BillingInfoFormHandler()

Method Summary

void	addAddressValidationFormError(java.util.List pMissingProperties, atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Utility method to add form exception.
void	addCreditCardAuthorizationNumber(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) This method add and validates the credit card authorization number the credit card if order payment is payed by the credit card.
void	addCreditCardBillingAddress(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) This method add and validates the billing Address to the credit card if order payment is payed by the credit card.
void	addCreditCardToProfile(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) This method is for any processing required after billing info is entered.
protected void	billingWithNewAddressAndNewCard(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Run 'move to confirmation' pipeline chain and update order.
protected void	billingWithSavedAddressAndNewCard(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Run 'move to confirm' pipeline chain and update order
protected void	billingWithSavedCard(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Run 'move to confirmation' pipeline chain and update order.
protected void	billingWithStoreCredit(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Run 'move to confirmation' pipeline chain and update order
java.lang.String	getBillingAddressNickname()
StoreBillingProcessHelper	getBillingHelper()
atg.commerce.catalog.CatalogTools	getCatalogTools()
CheckoutProgressStates	getCheckoutProgressStates()
java.lang.String	getCouponCode()
atg.commerce.order.CreditCard	getCreditCard() Utility method to fetch credit card and set properties from page.
atg.core.util.ContactInfo	getCreditCardBillingAddress()
java.lang.String	getCreditCardExpirationMonth()
java.lang.String	getCreditCardExpirationYear()
java.lang.String	getCreditCardNickname()
java.lang.String	getCreditCardNumber()
atg.payment.creditcard.ExtendableCreditCardTools	getCreditCardTools()
java.lang.String	getCreditCardType()
java.lang.String	getCreditCardVerificationNumber()
java.lang.String	getDateFormat()
java.lang.String	getDateOfBirth()
java.lang.String	getEmail()
java.lang.String	getEmailOptInSourceCode()
int	getMaxNickNameLength()
int	getMinNickNameLength()
java.lang.String	getMoveToConfirmationChainId()
java.lang.String	getMoveToConfirmErrorURL()
java.lang.String	getMoveToConfirmSuccessURL()
java.lang.String	getNewCreditCardVerificationNumber()
java.lang.String	getNewUserPassword()
StorePropertyManager	getProfilePropertyManager()
java.lang.String	getRegisterAccountErrorURL()
java.lang.String	getRegisterAccountSuccessURL()
java.lang.String	getRetypeNewPassword()
StoreConfiguration	getStoreConfiguration()
java.lang.String	getStoredAddressSelection()
java.lang.String	getStoredCreditCardName()
java.util.Map	getValue() Returns map of profile values
boolean	handleApplyStoreCreditsToOrder(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Apply available store credits to order.
boolean	handleBillingWithNewAddressAndNewCard(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Move to confirmation using new billing address and new credit card info.
boolean	handleBillingWithSavedAddressAndNewCard(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Move to confirmation using saved billing address and new credit card info.
boolean	handleBillingWithSavedCard(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Move to confirmation using saved credit card.
boolean	handleBillingWithStoreCredit(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Move to confirmation using only store credit as payment method.
boolean	handleRegisterUser(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Register an account and link all the saved information like the addresses and credit card info.
void	initializeBillingAddressSelection() Sets initial values to storedAddressSelection and usingSavedAddress fields based on the order
void	initializeCreditCardSelection() Sets initial values to storedCreditCardName and usingProfileCreditCard fields based on the order
boolean	isEmailOptIn()
boolean	isSaveBillingAddress()
boolean	isSaveCreditCard()
boolean	isSaveShippingInfo()
boolean	isUsingProfileCreditCard()
boolean	isUsingSavedAddress()
boolean	isUsingStoreCredit()
boolean	moveToConfirmExceptionHandling(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse)
void	postAddCreditCardAuthorizationNumber(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse)
void	postAddCreditCardBillingAddress(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse)
void	postAddCreditCardToProfile(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) This method is for any processing required after billing info is entered.
protected void	postBillingWithNewAddressAndNewCard(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Add credit card to user profile, update checkout level.
protected void	postBillingWithSavedAddressAndNewCard(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Add newly created card to profile, update checkout progress level
protected void	postBillingWithSavedCard(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Save billing address as default if user doesn't have one, update checkout level.
protected void	postBillingWithStoreCredit(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Update checkout progress level.
void	postRegisterUserAfterCheckout(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) This method will execute when the user chose to check out anonymous and then decided to register.
void	postSetupCreditCardPaymentGroupsForOrder(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Update checkout states with CONFIRM level.
void	postSetupStoreCreditPaymentGroupsForOrder(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) This method is post setup of store credit payment groups
void	preAddCreditCardAuthorizationNumber(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse)
void	preAddCreditCardBillingAddress(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse)
void	preAddCreditCardToProfile(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) This method is for any processing required after billing info is entered.
protected void	preBillingWithNewAddressAndNewCard(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Setup credit card payment group and validate user input
protected void	preBillingWithSavedAddressAndNewCard(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Setup credit card payment and validate user input.
protected void	preBillingWithSavedCard(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Setup credit card payment group for billing with saved card and validate credit card input
protected void	preBillingWithStoreCredit(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Tender coupon before billing with store credit occurs.
boolean	preMoveToConfirmExceptionHandling(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse)
void	preRegisterUserAfterCheckout(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) This method should execute when the user chose to check out anonymous and then decided to register.
void	preSetupCreditCardPaymentGroupsForOrder(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse)
void	preSetupStoreCreditPaymentGroupsForOrder(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse)
protected void	processOrderBilling(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Run pipeline chain responsible for order billing and update (save) order
void	registerUserAfterCheckout(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) This method should execute when the user chose to check out anonymous and then decided to register.
void	runProcessMoveToConfirmation(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Run the pipeline.
void	setBillingAddressNickname(java.lang.String pBillingAddressNickname)
void	setBillingHelper(StoreBillingProcessHelper pBillingHelper)
void	setCatalogTools(atg.commerce.catalog.CatalogTools pCatalogTools)
void	setCheckoutProgressStates(CheckoutProgressStates pCheckoutProgressStates)
void	setCouponCode(java.lang.String pCouponCode)
void	setCreditCardBillingAddress(atg.core.util.ContactInfo pCreditCardBillingAddress)
void	setCreditCardExpirationMonth(java.lang.String pCreditCardExpirationMonth)
void	setCreditCardExpirationYear(java.lang.String pCreditCardExpirationYear)
void	setCreditCardNickname(java.lang.String pCreditCardNickname)
void	setCreditCardNumber(java.lang.String pCreditCardNumber)
void	setCreditCardTools(atg.payment.creditcard.ExtendableCreditCardTools pCreditCardTools)
void	setCreditCardType(java.lang.String pCreditCardType)
void	setCreditCardVerificationNumber(java.lang.String pCreditCardVerificationNumber)
void	setDateFormat(java.lang.String pDateFormat)
void	setDateOfBirth(java.lang.String pDateOfBirth)
void	setEmail(java.lang.String pEmail)
void	setEmailOptIn(boolean pEmailOptIn)
void	setEmailOptInSourceCode(java.lang.String pEmailOptInSourceCode)
void	setMaxNickNameLength(int pMaxNickNameLength)
void	setMinNickNameLength(int pMinNickNameLength)
void	setMoveToConfirmationChainId(java.lang.String pMoveToConfirmationChainId)
void	setMoveToConfirmErrorURL(java.lang.String pMoveToConfirmErrorURL)
void	setMoveToConfirmSuccessURL(java.lang.String pMoveToConfirmSuccessURL)
void	setNewCreditCardVerificationNumber(java.lang.String pNewCreditCardVerificationNumber)
void	setNewUserPassword(java.lang.String pNewUserPassword)
void	setProfilePropertyManager(StorePropertyManager pProfilePropertyManager)
void	setRegisterAccountErrorURL(java.lang.String pRegisterAccountErrorURL)
void	setRegisterAccountSuccessURL(java.lang.String pRegisterAccountSuccessURL)
void	setRetypeNewPassword(java.lang.String pRetypeNewPassword)
void	setSaveBillingAddress(boolean pSaveBillingAddress)
void	setSaveCreditCard(boolean pSaveCreditCard)
void	setSaveShippingInfo(boolean pSaveShippingInfo)
void	setStoreConfiguration(StoreConfiguration pStoreConfiguration)
void	setStoredAddressSelection(java.lang.String pStoredAddressSelection)
void	setStoredCreditCardName(java.lang.String pStoredCreditCardName)
void	setupCreditCardPaymentGroupsForOrder(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) This method Initialize and setup Credit Card Payment group for the order, if store credit is used, then all amount from the order deducted by the store credit, then by credit card.
void	setupStoreCreditPaymentGroupsForOrder(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) This method Initialize and setup StoreCredit Payment group for the order, if store credit is used
void	setUsingProfileCreditCard(boolean pUsingProfileCreditCard)
void	setUsingSavedAddress(boolean pUsingSavedAddress)
void	setUsingStoreCredit(boolean pUsingStoreCredit)
void	setValue(java.util.Map pValue) Sets map of profile values
protected void	updateCheckoutProgressState() If no errors, update checkout progress state with CONFIRM level.
protected boolean	validateBillingAddress(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Validates the billing address, Not Validate, if Order Amount is not payed by Credit Card
protected void	validateCreditCardAuthorizationNumber(java.lang.String pAuthNumber, atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Verifies that the auth number is valued and a number.
boolean	validateCreditCardInput(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) This method uses the CreditCardTools to validate the credit card.
boolean	validateCreditCardNicknameInput(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) This method validates the credit card nickname if one is required.
protected boolean	validateEmailAddress() Utility method to validate email address.
protected boolean	validatePassword() Utility method to validate password input.

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

acquireTransactionLock, acquireTransactionLock, afterSet, beforeSet, checkFormRedirect, commitTransaction, copyConfiguration, createRepriceParameterMap, defaultLocalLockManager, defaultUserProfile, doStartService, ensureTransaction, formatUserMessage, formatUserMessage, formatUserMessage, formatUserMessage, generatePropertyPath, getClaimableManager, getCommerceIdentifierPaymentInfoContainer, getCommerceItemManager, getCommerceItemShippingInfoContainer, getCommerceProfileTools, getCommercePropertyManager, getConfiguration, getCurrentTransaction, getDefaultLocale, getGiftlistManager, getHandlingInstructionManager, getLocalLockManager, getOrder, getOrderManager, getPaymentGroupManager, getPaymentGroupMapContainer, getPipelineManager, getPriceList, getPriceListId, getPriceListManager, getProfile, getProfileRepository, getPurchaseProcessHelper, getRepeatingRequestMonitor, getRepriceOrderChainId, getResourceBundle, getResourceBundle, getResourceBundleName, getSessionExpirationURL, getShippingGroupManager, getShippingGroupMapContainer, getShoppingCart, getTransactionManager, getUserLocale, getUserLocale, getUserPricingModels, handlePipelineError, 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

Methods inherited from class atg.droplet.GenericFormHandler

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

Methods inherited from class atg.droplet.EmptyFormHandler

afterGet, beforeGet

Methods inherited from class atg.nucleus.GenericService

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

Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

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

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static final java.lang.String CLASS_VERSION

Class version string.

See Also:

Constant Field Values

COUNTRY_KEY_PREFIX

public static final java.lang.String COUNTRY_KEY_PREFIX

See Also:

Constant Field Values

COUNTRY_STATE_RESOURCES

public static final java.lang.String COUNTRY_STATE_RESOURCES

See Also:

Constant Field Values

MSG_ERROR_MOVE_TO_CONFIRM

protected static final java.lang.String MSG_ERROR_MOVE_TO_CONFIRM

Error while confirmation message key.

See Also:

Constant Field Values

MSG_ERROR_UPDATE_ORDER

protected static final java.lang.String MSG_ERROR_UPDATE_ORDER

Error updating order message key.

See Also:

Constant Field Values

MSG_ERROR_INCORRECT_STATE

protected static final java.lang.String MSG_ERROR_INCORRECT_STATE

Error message for incorrect state

See Also:

Constant Field Values

mCreditCardVerificationNumber

protected java.lang.String mCreditCardVerificationNumber

Property for holding the credit card verification number for a stored credit card.

mNewCreditCardVerificationNumber

protected java.lang.String mNewCreditCardVerificationNumber

Property for holding the credit card verification number for a new credit card.

mSaveCreditCard

protected boolean mSaveCreditCard

Should save credit card data.

mEmailOptIn

protected boolean mEmailOptIn

Is e-mail option turned in.

mEmailOptInSourceCode

protected java.lang.String mEmailOptInSourceCode

E-mail option source code.

mStoredCreditCardName

protected java.lang.String mStoredCreditCardName

Stores credit card name.

mStoredAddressSelection

protected java.lang.String mStoredAddressSelection

Stored address selection.

mNewUserPassword

protected java.lang.String mNewUserPassword

New user password.

mRetypeNewPassword

protected java.lang.String mRetypeNewPassword

Retypes new password.

mValue

protected java.util.Map mValue

Property to hold profile values

mMoveToConfirmationChainId

protected java.lang.String mMoveToConfirmationChainId

Move to confirmation chain id.

mBillingAddressNickname

protected java.lang.String mBillingAddressNickname

Billing Address nickname

mEmail

protected java.lang.String mEmail

E-mail.

mSaveShippingInfo

protected boolean mSaveShippingInfo

Should save shipping information.

mMinNickNameLength

protected int mMinNickNameLength

Minimum nickname length.

mMaxNickNameLength

protected int mMaxNickNameLength

Maximum nickname length.

mCreditCardNickname

protected java.lang.String mCreditCardNickname

Credit card nickname.

mCreditCardType

protected java.lang.String mCreditCardType

Credit card type

mCreditCardNumber

protected java.lang.String mCreditCardNumber

Credit card number

mCreditCardExpirationMonth

protected java.lang.String mCreditCardExpirationMonth

Credit card expiration month

mCreditCardExpirationYear

protected java.lang.String mCreditCardExpirationYear

Credit card expiration year

mCreditCardBillingAddress

protected atg.core.util.ContactInfo mCreditCardBillingAddress

Credit card billing address

mMoveToConfirmErrorURL

protected java.lang.String mMoveToConfirmErrorURL

Move to confirm error redirect URL.

mMoveToConfirmSuccessURL

protected java.lang.String mMoveToConfirmSuccessURL

Move to confirm success redirect URL.

mRegisterAccountSuccessURL

protected java.lang.String mRegisterAccountSuccessURL

mRegisterAccountErrorURL

protected java.lang.String mRegisterAccountErrorURL

mStoreConfiguration

protected StoreConfiguration mStoreConfiguration

Store configuration.

mCatalogTools

protected atg.commerce.catalog.CatalogTools mCatalogTools

Catalog tools.

mUsingProfileCreditCard

protected boolean mUsingProfileCreditCard

Is the credit card saved in the user's profile.

mUsingSavedAddress

protected boolean mUsingSavedAddress

Is the address in the user's profile.

mUsingStoreCredit

protected boolean mUsingStoreCredit

Is order covered with store credit only.

Constructor Detail

BillingInfoFormHandler

public BillingInfoFormHandler()

Method Detail

getCheckoutProgressStates

public CheckoutProgressStates getCheckoutProgressStates()

Returns:

the mCheckoutProgressStates

setCheckoutProgressStates

public void setCheckoutProgressStates(CheckoutProgressStates pCheckoutProgressStates)

Parameters:

pCheckoutProgressStates - the checkoutProgressStates to set

getCouponCode

public java.lang.String getCouponCode()

Returns:

a coupon code to be claimed

setCouponCode

public void setCouponCode(java.lang.String pCouponCode)

Parameters:

pCouponCode - a coupon code to set

getProfilePropertyManager

public StorePropertyManager getProfilePropertyManager()

Returns:

the mProfilePropertyManager

setProfilePropertyManager

public void setProfilePropertyManager(StorePropertyManager pProfilePropertyManager)

Parameters:

pProfilePropertyManager - the profilePropertyManager to set

getBillingHelper

public StoreBillingProcessHelper getBillingHelper()

Returns:

the mBillingHelper

setBillingHelper

public void setBillingHelper(StoreBillingProcessHelper pBillingHelper)

Parameters:

pBillingHelper - the billingHelper to set

getCreditCardVerificationNumber

public java.lang.String getCreditCardVerificationNumber()

Returns:

the credit card verification number.

setCreditCardVerificationNumber

public void setCreditCardVerificationNumber(java.lang.String pCreditCardVerificationNumber)

Parameters:

pCreditCardVerificationNumber - - the credit card verification number to set.

getNewCreditCardVerificationNumber

public java.lang.String getNewCreditCardVerificationNumber()

Returns:

the new credit card verification number.

setNewCreditCardVerificationNumber

public void setNewCreditCardVerificationNumber(java.lang.String pNewCreditCardVerificationNumber)

Parameters:

pNewCreditCardVerificationNumber - - the credit card verification number to set.

isSaveCreditCard

public boolean isSaveCreditCard()

Returns:

true if user selected to save the credit card, false - otherwise.

setSaveCreditCard

public void setSaveCreditCard(boolean pSaveCreditCard)

Parameters:

pSaveCreditCard - - if user selects to save the credit card.

isEmailOptIn

public boolean isEmailOptIn()

Returns:

ture if user selected to opt in, false - otherwise.

setEmailOptIn

public void setEmailOptIn(boolean pEmailOptIn)

Parameters:

pEmailOptIn - - true if user selects to opt in, false - otherwise.

getEmailOptInSourceCode

public java.lang.String getEmailOptInSourceCode()

Returns:

E-mail opt in source code.

setEmailOptInSourceCode

public void setEmailOptInSourceCode(java.lang.String pEmailOptInSourceCode)

Parameters:

pEmailOptInSourceCode - - e-mail opt in source code.

getStoredCreditCardName

public java.lang.String getStoredCreditCardName()

Returns:

stores credit card name.

setStoredCreditCardName

public void setStoredCreditCardName(java.lang.String pStoredCreditCardName)

Parameters:

pStoredCreditCardName - - stored credit card name.

getStoredAddressSelection

public java.lang.String getStoredAddressSelection()

Returns:

stored address selection.

setStoredAddressSelection

public void setStoredAddressSelection(java.lang.String pStoredAddressSelection)

Parameters:

pStoredAddressSelection - - stored address selection.

getNewUserPassword

public java.lang.String getNewUserPassword()

Returns:

new user password.

setNewUserPassword

public void setNewUserPassword(java.lang.String pNewUserPassword)

Parameters:

pNewUserPassword - - new user password.

getRetypeNewPassword

public java.lang.String getRetypeNewPassword()

Returns:

retyped new password.

setRetypeNewPassword

public void setRetypeNewPassword(java.lang.String pRetypeNewPassword)

Parameters:

pRetypeNewPassword - - retyped new password.

getValue

public java.util.Map getValue()

Returns map of profile values

Returns:

map of profile values

setValue

public void setValue(java.util.Map pValue)

Sets map of profile values

Parameters:

pValue - map of values

getDateOfBirth

public java.lang.String getDateOfBirth()

Returns:

date of birth.

setDateOfBirth

public void setDateOfBirth(java.lang.String pDateOfBirth)

Parameters:

pDateOfBirth - - date of birth.

getDateFormat

public java.lang.String getDateFormat()

Returns:

date format.

setDateFormat

public void setDateFormat(java.lang.String pDateFormat)

Parameters:

pDateFormat - - date format.

getMoveToConfirmationChainId

public java.lang.String getMoveToConfirmationChainId()

Returns:

move to confirmation chain id.

setMoveToConfirmationChainId

public void setMoveToConfirmationChainId(java.lang.String pMoveToConfirmationChainId)

Parameters:

pMoveToConfirmationChainId - - move to confirmation chain id.

getBillingAddressNickname

public java.lang.String getBillingAddressNickname()

Returns:

the billing address nickname.

setBillingAddressNickname

public void setBillingAddressNickname(java.lang.String pBillingAddressNickname)

Parameters:

pBillingAddressNickname - - the billing address nickname to set.

getEmail

public java.lang.String getEmail()

Returns:

Email property.

setEmail

public void setEmail(java.lang.String pEmail)

Parameters:

pEmail - - property for the email property.

isSaveShippingInfo

public boolean isSaveShippingInfo()

Returns:

the save shippingInfo.

setSaveShippingInfo

public void setSaveShippingInfo(boolean pSaveShippingInfo)

Parameters:

pSaveShippingInfo - - the save shipping information to set.

getMinNickNameLength

public int getMinNickNameLength()

Returns:

minimum nickname length.

setMinNickNameLength

public void setMinNickNameLength(int pMinNickNameLength)

Parameters:

pMinNickNameLength - - minimum nickname length.

getMaxNickNameLength

public int getMaxNickNameLength()

Returns:

maximum nickname length.

setMaxNickNameLength

public void setMaxNickNameLength(int pMaxNickNameLength)

Parameters:

pMaxNickNameLength - - maximum nickname length.

getCreditCardNickname

public java.lang.String getCreditCardNickname()

Returns:

the credit card nickname.

setCreditCardNickname

public void setCreditCardNickname(java.lang.String pCreditCardNickname)

Parameters:

pCreditCardNickname - - the credit card nickname to set.

getCreditCardType

public java.lang.String getCreditCardType()

Returns:

the credit card ype.

setCreditCardType

public void setCreditCardType(java.lang.String pCreditCardType)

Parameters:

pCreditCardType - - the credit card type to set.

getCreditCardNumber

public java.lang.String getCreditCardNumber()

Returns:

the creditCardNumber

setCreditCardNumber

public void setCreditCardNumber(java.lang.String pCreditCardNumber)

Parameters:

pCreditCardNumber - the creditCardNumber to set

getCreditCardExpirationMonth

public java.lang.String getCreditCardExpirationMonth()

Returns:

the creditCardExpirationMonth

setCreditCardExpirationMonth

public void setCreditCardExpirationMonth(java.lang.String pCreditCardExpirationMonth)

Parameters:

pCreditCardExpirationMonth - the creditCardExpirationMonth to set

getCreditCardExpirationYear

public java.lang.String getCreditCardExpirationYear()

Returns:

the creditCardExpirationYear

setCreditCardExpirationYear

public void setCreditCardExpirationYear(java.lang.String pCreditCardExpirationYear)

Parameters:

pCreditCardExpirationYear - the creditCardExpirationYear to set

getCreditCardBillingAddress

public atg.core.util.ContactInfo getCreditCardBillingAddress()

Returns:

the creditCardBillingAddress

setCreditCardBillingAddress

public void setCreditCardBillingAddress(atg.core.util.ContactInfo pCreditCardBillingAddress)

Parameters:

pCreditCardBillingAddress - the creditCardBillingAddress to set

getMoveToConfirmErrorURL

public java.lang.String getMoveToConfirmErrorURL()

Returns:

move to confirm error redirect URL.

setMoveToConfirmErrorURL

public void setMoveToConfirmErrorURL(java.lang.String pMoveToConfirmErrorURL)

Parameters:

pMoveToConfirmErrorURL - - move to confirm error redirect URL.

getMoveToConfirmSuccessURL

public java.lang.String getMoveToConfirmSuccessURL()

Returns:

move to confirm error redirect URL.

setMoveToConfirmSuccessURL

public void setMoveToConfirmSuccessURL(java.lang.String pMoveToConfirmSuccessURL)

Parameters:

pMoveToConfirmSuccessURL - - move to confirm success redirect URL.

getRegisterAccountSuccessURL

public java.lang.String getRegisterAccountSuccessURL()

Returns:

the register account success URL

setRegisterAccountSuccessURL

public void setRegisterAccountSuccessURL(java.lang.String pRegisterAccountSuccessURL)

Parameters:

pRegisterAccountSuccessURL - the register account success URL to set

getRegisterAccountErrorURL

public java.lang.String getRegisterAccountErrorURL()

Returns:

the register account error URL

setRegisterAccountErrorURL

public void setRegisterAccountErrorURL(java.lang.String pRegisterAccountErrorURL)

Parameters:

pRegisterAccountErrorURL - the register account error URL to set

getStoreConfiguration

public StoreConfiguration getStoreConfiguration()

Returns:

the store configuration.

setStoreConfiguration

public void setStoreConfiguration(StoreConfiguration pStoreConfiguration)

Parameters:

pStoreConfiguration - - the store configuration to set.

getCatalogTools

public atg.commerce.catalog.CatalogTools getCatalogTools()

Returns:

catalog tools.

setCatalogTools

public void setCatalogTools(atg.commerce.catalog.CatalogTools pCatalogTools)

Parameters:

pCatalogTools - - catalog tools.

isUsingProfileCreditCard

public boolean isUsingProfileCreditCard()

Returns:

Is the credit card saved in the user's profile.

setUsingProfileCreditCard

public void setUsingProfileCreditCard(boolean pUsingProfileCreditCard)

Parameters:

pUsingProfileCreditCard - - is the credit card saved in the user's profile.

isUsingSavedAddress

public boolean isUsingSavedAddress()

Returns:

Is the address saved in the user's profile.

setUsingSavedAddress

public void setUsingSavedAddress(boolean pUsingSavedAddress)

Parameters:

pUsingSavedAddress - - Is the address saved in the user's profile.

isSaveBillingAddress

public boolean isSaveBillingAddress()

Returns:

true if billing address should be saved, false - otherwise.

setSaveBillingAddress

public void setSaveBillingAddress(boolean pSaveBillingAddress)

Parameters:

pSaveBillingAddress - - true if billing address should be saved, false - otherwise.

isUsingStoreCredit

public boolean isUsingStoreCredit()

Returns:

Is order covered with store credit only.

setUsingStoreCredit

public void setUsingStoreCredit(boolean pUsingStoreCredit)

Parameters:

pUsingStoreCredit - - Is order covered with store credit only.

getCreditCardTools

public atg.payment.creditcard.ExtendableCreditCardTools getCreditCardTools()

Returns:

ExtendableCreditCardTools

setCreditCardTools

public void setCreditCardTools(atg.payment.creditcard.ExtendableCreditCardTools pCreditCardTools)

Parameters:

pCreditCardTools - new ExtendableCreditCardTools

preSetupStoreCreditPaymentGroupsForOrder

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

Parameters:

pRequest - a DynamoHttpServletRequest value

pResponse - a DynamoHttpServletResponse value

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs

setupStoreCreditPaymentGroupsForOrder

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

This method Initialize and setup StoreCredit Payment group for the order, if store credit is used

Parameters:

pRequest - a DynamoHttpServletRequest value

pResponse - a DynamoHttpServletResponse value

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs

postSetupStoreCreditPaymentGroupsForOrder

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

This method is post setup of store credit payment groups

Parameters:

pRequest - a DynamoHttpServletRequest value

pResponse - a DynamoHttpServletResponse value

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs

preAddCreditCardBillingAddress

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

Parameters:

pRequest - a DynamoHttpServletRequest value

pResponse - a DynamoHttpServletResponse value

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs

addCreditCardBillingAddress

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

This method add and validates the billing Address to the credit card if order payment is payed by the credit card.

Parameters:

pRequest - a DynamoHttpServletRequest value

pResponse - a DynamoHttpServletResponse value

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs

postAddCreditCardBillingAddress

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

Parameters:

pRequest - a DynamoHttpServletRequest value

pResponse - a DynamoHttpServletResponse value

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs

preAddCreditCardAuthorizationNumber

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

Parameters:

pRequest - a DynamoHttpServletRequest value

pResponse - a DynamoHttpServletResponse value

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs

addCreditCardAuthorizationNumber

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

This method add and validates the credit card authorization number the credit card if order payment is payed by the credit card.

Parameters:

pRequest - a DynamoHttpServletRequest value

pResponse - a DynamoHttpServletResponse value

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs

postAddCreditCardAuthorizationNumber

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

Parameters:

pRequest - a DynamoHttpServletRequest value

pResponse - a DynamoHttpServletResponse value

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs

preSetupCreditCardPaymentGroupsForOrder

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

Parameters:

pRequest - a DynamoHttpServletRequest value

pResponse - a DynamoHttpServletResponse value

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs

atg.commerce.CommerceException

setupCreditCardPaymentGroupsForOrder

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

This method Initialize and setup Credit Card Payment group for the order, if store credit is used, then all amount from the order deducted by the store credit, then by credit card.

Parameters:

pRequest - a DynamoHttpServletRequest value

pResponse - a DynamoHttpServletResponse value

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs

postSetupCreditCardPaymentGroupsForOrder

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

Update checkout states with CONFIRM level.

Parameters:

pRequest - a DynamoHttpServletRequest value

pResponse - a DynamoHttpServletResponse value

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs

preAddCreditCardToProfile

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

This method is for any processing required after billing info is entered. It will register the user if the user is required to register, and save the credit card to the profile if the user chose that option.

Parameters:

pRequest - a DynamoHttpServletRequest value

pResponse - a DynamoHttpServletResponse value

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs

addCreditCardToProfile

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

This method is for any processing required after billing info is entered. It will register the user if the user is required to register, and save the credit card to the profile if the user chose that option.

Parameters:

pRequest - a DynamoHttpServletRequest value

pResponse - a DynamoHttpServletResponse value

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs

postAddCreditCardToProfile

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

This method is for any processing required after billing info is entered. It will register the user if the user is required to register, and save the credit card to the profile if the user chose that option.

Parameters:

pRequest - a DynamoHttpServletRequest value

pResponse - a DynamoHttpServletResponse value

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs

preRegisterUserAfterCheckout

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

This method should execute when the user chose to check out anonymous and then decided to register. And it will validate and set the required feilds for registered user

Parameters:

pRequest - a DynamoHttpServletRequest value

pResponse - a DynamoHttpServletResponse value

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs

registerUserAfterCheckout

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

This method should execute when the user chose to check out anonymous and then decided to register. Following are the executions 1) Saving shipping address to profile 2) Register user 3) Add the order to the repository

Parameters:

pRequest - a DynamoHttpServletRequest value

pResponse - a DynamoHttpServletResponse value

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs

postRegisterUserAfterCheckout

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

This method will execute when the user chose to check out anonymous and then decided to register.

Parameters:

pRequest - a DynamoHttpServletRequest value

pResponse - a DynamoHttpServletResponse value

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs

runProcessMoveToConfirmation

public void runProcessMoveToConfirmation(atg.servlet.DynamoHttpServletRequest pRequest,
                                         atg.servlet.DynamoHttpServletResponse pResponse)
                                  throws atg.service.pipeline.RunProcessException,
                                         javax.servlet.ServletException,
                                         java.io.IOException

Run the pipeline.

Parameters:

pRequest - a DynamoHttpServletRequest value

pResponse - a DynamoHttpServletResponse value

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs

atg.service.pipeline.RunProcessException - if error running pipeline process

validateEmailAddress

protected boolean validateEmailAddress()

Utility method to validate email address.

Returns:

true if success, false - otherwise

validatePassword

protected boolean validatePassword()

Utility method to validate password input.

Returns:

true if success, false - otherwise

validateCreditCardInput

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

This method uses the CreditCardTools to validate the credit card.

Parameters:

pRequest - a DynamoHttpServletRequest value

pResponse - a DynamoHttpServletResponse value

Returns:

true if success, false - otherwise

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs

atg.commerce.CommerceException - indicates that a severe error occurred while performing a commerce operation

See Also:

ExtendableCreditCardTools

validateCreditCardNicknameInput

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

This method validates the credit card nickname if one is required.

Parameters:

pRequest - - http request

pResponse - - http response

Returns:

true if success, false - otherwise

Throws:

java.io.IOException

javax.servlet.ServletException

getCreditCard

public atg.commerce.order.CreditCard getCreditCard()

Utility method to fetch credit card and set properties from page.

Returns:

credit card for this order

validateCreditCardAuthorizationNumber

protected void validateCreditCardAuthorizationNumber(java.lang.String pAuthNumber,
                                                     atg.servlet.DynamoHttpServletRequest pRequest,
                                                     atg.servlet.DynamoHttpServletResponse pResponse)
                                              throws javax.servlet.ServletException,
                                                     java.io.IOException

Verifies that the auth number is valued and a number.

Parameters:

pAuthNumber - - authentication number

pRequest - a DynamoHttpServletRequest value

pResponse - a DynamoHttpServletResponse value

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs

validateBillingAddress

protected boolean validateBillingAddress(atg.servlet.DynamoHttpServletRequest pRequest,
                                         atg.servlet.DynamoHttpServletResponse pResponse)

Validates the billing address, Not Validate, if Order Amount is not payed by Credit Card

Parameters:

pRequest - - http request

pResponse - - http response

Returns:

true if billing address is missing, false otherwise

handleBillingWithSavedCard

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

Move to confirmation using saved credit card.

Parameters:

pRequest - a DynamoHttpServletRequest value

pResponse - a DynamoHttpServletResponse value

Returns:

a boolean value

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs

atg.commerce.CommerceException

preBillingWithSavedCard

protected void preBillingWithSavedCard(atg.servlet.DynamoHttpServletRequest pRequest,
                                       atg.servlet.DynamoHttpServletResponse pResponse)
                                throws atg.commerce.CommerceException,
                                       java.io.IOException,
                                       javax.servlet.ServletException

Setup credit card payment group for billing with saved card and validate credit card input

Parameters:

pRequest - Dynamo HTTP request

pResponse - Dynamo HTTP response

Throws:

atg.commerce.CommerceException

java.io.IOException

javax.servlet.ServletException

billingWithSavedCard

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

Run 'move to confirmation' pipeline chain and update order.

Parameters:

pRequest - Dynamo HTTP request

pResponse - Dynamo HTTP response

Throws:

javax.servlet.ServletException

java.io.IOException

postBillingWithSavedCard

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

Save billing address as default if user doesn't have one, update checkout level.

Parameters:

pRequest - Dynamo HTTP request

pResponse - Dynamo HTTP response

Throws:

javax.servlet.ServletException

java.io.IOException

handleBillingWithNewAddressAndNewCard

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

Move to confirmation using new billing address and new credit card info.

Parameters:

pRequest - a DynamoHttpServletRequest value

pResponse - a DynamoHttpServletResponse value

Returns:

a boolean value

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs

atg.commerce.CommerceException

preBillingWithNewAddressAndNewCard

protected void preBillingWithNewAddressAndNewCard(atg.servlet.DynamoHttpServletRequest pRequest,
                                                  atg.servlet.DynamoHttpServletResponse pResponse)
                                           throws javax.servlet.ServletException,
                                                  java.io.IOException,
                                                  atg.commerce.CommerceException

Setup credit card payment group and validate user input

Parameters:

pRequest - Dynamo HTTP request

pResponse - Dynamo HTTP response

Throws:

javax.servlet.ServletException

java.io.IOException

atg.commerce.CommerceException

billingWithNewAddressAndNewCard

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

Run 'move to confirmation' pipeline chain and update order.

Parameters:

pRequest - Dynamo HTTP request

pResponse - Dynamo HTTP response

Throws:

javax.servlet.ServletException

java.io.IOException

postBillingWithNewAddressAndNewCard

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

Add credit card to user profile, update checkout level.

Parameters:

pRequest - Dynamo HTTP request

pResponse - Dynamo HTTP response

Throws:

javax.servlet.ServletException

java.io.IOException

handleBillingWithSavedAddressAndNewCard

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

Move to confirmation using saved billing address and new credit card info.

Parameters:

pRequest - a DynamoHttpServletRequest value

pResponse - a DynamoHttpServletResponse value

Returns:

a boolean value

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs

atg.commerce.CommerceException

preBillingWithSavedAddressAndNewCard

protected void preBillingWithSavedAddressAndNewCard(atg.servlet.DynamoHttpServletRequest pRequest,
                                                    atg.servlet.DynamoHttpServletResponse pResponse)
                                             throws javax.servlet.ServletException,
                                                    java.io.IOException,
                                                    atg.commerce.CommerceException

Setup credit card payment and validate user input.

Parameters:

pRequest - Dynamo HTTP request

pResponse - Dynamo HTTP response

Throws:

javax.servlet.ServletException

java.io.IOException

atg.commerce.CommerceException

billingWithSavedAddressAndNewCard

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

Run 'move to confirm' pipeline chain and update order

Parameters:

pRequest - Dynamo HTTP request

pResponse - Dynamo HTTP response

Throws:

javax.servlet.ServletException

java.io.IOException

postBillingWithSavedAddressAndNewCard

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

Add newly created card to profile, update checkout progress level

Parameters:

pRequest - Dynamo HTTP request

pResponse - Dynamo HTTP response

Throws:

javax.servlet.ServletException

java.io.IOException

handleBillingWithStoreCredit

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

Move to confirmation using only store credit as payment method.

Parameters:

pRequest - a DynamoHttpServletRequest value

pResponse - a DynamoHttpServletResponse value

Returns:

a boolean value

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs

atg.commerce.CommerceException

preBillingWithStoreCredit

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

Tender coupon before billing with store credit occurs.

Parameters:

pRequest - Dynamo HTTP request

pResponse - Dynamo HTTP response

Throws:

javax.servlet.ServletException

java.io.IOException

postBillingWithStoreCredit

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

Update checkout progress level.

Parameters:

pRequest -

pResponse -

Throws:

javax.servlet.ServletException

java.io.IOException

billingWithStoreCredit

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

Run 'move to confirmation' pipeline chain and update order

Parameters:

pRequest - Dynamo HTTP request

pResponse - Dynamo HTTP response

Throws:

javax.servlet.ServletException

java.io.IOException

handleApplyStoreCreditsToOrder

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

Apply available store credits to order.

Parameters:

pRequest - a DynamoHttpServletRequest value

pResponse - a DynamoHttpServletResponse value

Returns:

true on success, false - otherwise

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs

handleRegisterUser

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

Register an account and link all the saved information like the addresses and credit card info.

Parameters:

pRequest - a DynamoHttpServletRequest value

pResponse - a DynamoHttpServletResponse value

Returns:

If redirect (for whatever reason) to a new page occurred, return false. If NO redirect occurred, return true.

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs

moveToConfirmExceptionHandling

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

Parameters:

pRequest - a DynamoHttpServletRequest value

pResponse - a DynamoHttpServletResponse value

Returns:

If redirect (for whatever reason) to a new page occurred, return false. If NO redirect occurred, return true.

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs

preMoveToConfirmExceptionHandling

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

Parameters:

pRequest - a DynamoHttpServletRequest value

pResponse - a DynamoHttpServletResponse value

Returns:

If redirect (for whatever reason) to a new page occurred, return false. If NO redirect occurred, return true.

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs

processOrderBilling

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

Run pipeline chain responsible for order billing and update (save) order

Parameters:

pRequest - http request

pResponse - http response

Throws:

javax.servlet.ServletException

java.io.IOException

updateCheckoutProgressState

protected void updateCheckoutProgressState()

If no errors, update checkout progress state with CONFIRM level. This is needed to display confirmation page.

addAddressValidationFormError

public void addAddressValidationFormError(java.util.List pMissingProperties,
                                          atg.servlet.DynamoHttpServletRequest pRequest,
                                          atg.servlet.DynamoHttpServletResponse pResponse)

Utility method to add form exception.

Parameters:

pMissingProperties - - missing properties list

pRequest - - http request

pResponse - - http response

initializeCreditCardSelection

public void initializeCreditCardSelection()

Sets initial values to storedCreditCardName and usingProfileCreditCard fields based on the order

initializeBillingAddressSelection

public void initializeBillingAddressSelection()

Sets initial values to storedAddressSelection and usingSavedAddress fields based on the order