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.
protected java.lang.String	mBillingAddressNickname Billing Address nickname
protected atg.commerce.catalog.CatalogTools	mCatalogTools Catalog tools.
protected java.lang.String	mCreditCardNickname Credit card nickname.
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 java.lang.String	mGiftCertificateNumbers Gift certificate numbers.
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[]	mOnlineCreditIds Online credit cards ids.
protected boolean	mRequiresRegistration Is registration required.
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.

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	debug() Logs debugging info about the form settings and payment group.
java.lang.String	getBillingAddressNickname()
StoreBillingProcessHelper	getBillingHelper()
atg.commerce.catalog.CatalogTools	getCatalogTools()
atg.commerce.order.CreditCard	getCreditCard() Utility method to fetch credit card and set properties from page.
java.lang.String	getCreditCardNickname()
java.lang.String	getCreditCardVerificationNumber()
java.lang.String	getEmail()
boolean	getEmailOptIn()
java.lang.String	getEmailOptInSourceCode()
java.lang.String	getGiftCertificateNumbers()
int	getMaxNickNameLength()
int	getMinNickNameLength()
java.lang.String	getMoveToConfirmationChainId()
java.lang.String	getMoveToConfirmErrorURL()
java.lang.String	getMoveToConfirmSuccessURL()
java.lang.String	getNewCreditCardVerificationNumber()
java.lang.String	getNewUserPassword()
java.lang.String[]	getOnlineCreditIds()
atg.commerce.util.PlaceUtils	getPlaceUtils()
boolean	getRequiresRegistration()
java.lang.String	getRetypeNewPassword()
boolean	getSaveCreditCard()
StoreConfiguration	getStoreConfiguration()
java.lang.String	getStoredAddressSelection()
java.lang.String	getStoredCreditCardName()
boolean	handleMoveToConfirm(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) This method runs the move to confirmation pipeline chain.
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	isSaveShippingInfo()
boolean	isUsingProfileCreditCard()
boolean	isUsingSavedAddress()
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.
void	postRegisterUserDuringCheckout(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse)
void	postSetupCreditCardPaymentGroupsForOrder(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse)
void	postSetupGiftCertificatePaymentGroupsForOrder(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse)
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.
boolean	preMoveToConfirmExceptionHandling(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse)
void	preRegisterUserDuringCheckout(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	preSetupGiftCertificatePaymentGroupsForOrder(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse)
void	preSetupStoreCreditPaymentGroupsForOrder(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse)
void	registerUserDuringCheckout(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	setCreditCardNickname(java.lang.String pCreditCardNickname)
void	setCreditCardVerificationNumber(java.lang.String pCreditCardVerificationNumber)
void	setEmail(java.lang.String pEmail)
void	setEmailOptIn(boolean pEmailOptIn)
void	setEmailOptInSourceCode(java.lang.String pEmailOptInSourceCode)
void	setGiftCertificateNumbers(java.lang.String pGiftCertificateNumbers)
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	setOnlineCreditIds(java.lang.String[] pOnlineCreditIds)
void	setPlaceUtils(atg.commerce.util.PlaceUtils pPlaceUtils) Sets place utils
void	setRequiresRegistration(boolean pRequiresRegistration)
void	setRetypeNewPassword(java.lang.String pRetypeNewPassword)
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 gift certificates and last by credit card.
void	setupGiftCertificatePaymentGroupsForOrder(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) This method Initialize and setup GiftCertificate Payment group for the order, if store credit is used, then all amount from the order detucted by the store credit, then remaining amount is detucted by gift certificates
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)
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.
void	validateGiftCertificateNumbers(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) Validate, wether the GiftCertificate number is valid or not
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, 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, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService

Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

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

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string.

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.

mRequiresRegistration

protected boolean mRequiresRegistration

Is registration required.

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.

mOnlineCreditIds

protected java.lang.String[] mOnlineCreditIds

Online credit cards ids.

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.

mGiftCertificateNumbers

protected java.lang.String mGiftCertificateNumbers

Gift certificate numbers.

mMinNickNameLength

protected int mMinNickNameLength

Minimum nickname length.

mMaxNickNameLength

protected int mMaxNickNameLength

Maximum nickname length.

mCreditCardNickname

protected java.lang.String mCreditCardNickname

Credit card nickname.

mMoveToConfirmErrorURL

protected java.lang.String mMoveToConfirmErrorURL

Move to confirm error redirect URL.

mMoveToConfirmSuccessURL

protected java.lang.String mMoveToConfirmSuccessURL

Move to confirm success redirect URL.

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.

Constructor Detail

BillingInfoFormHandler

public BillingInfoFormHandler()

Method Detail

getBillingHelper

public StoreBillingProcessHelper getBillingHelper()

setBillingHelper

public void setBillingHelper(StoreBillingProcessHelper pBillingHelper)

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.

getPlaceUtils

public atg.commerce.util.PlaceUtils getPlaceUtils()

Returns:

place utils

setPlaceUtils

public void setPlaceUtils(atg.commerce.util.PlaceUtils pPlaceUtils)

Sets place utils

Parameters:

pPlaceUtils -

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.

getSaveCreditCard

public boolean getSaveCreditCard()

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.

getEmailOptIn

public boolean getEmailOptIn()

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.

getRequiresRegistration

public boolean getRequiresRegistration()

Returns:

true if registration is required, false - otherwise.

setRequiresRegistration

public void setRequiresRegistration(boolean pRequiresRegistration)

Parameters:

pRequiresRegistration - - true if registration is required, false - otherwise.

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.

setOnlineCreditIds

public void setOnlineCreditIds(java.lang.String[] pOnlineCreditIds)

Parameters:

pOnlineCreditIds - - the online credit ids selected.

getOnlineCreditIds

public java.lang.String[] getOnlineCreditIds()

Returns:

online credit ids.

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.

setGiftCertificateNumbers

public void setGiftCertificateNumbers(java.lang.String pGiftCertificateNumbers)

Parameters:

pGiftCertificateNumbers - - gift certificate number.

getGiftCertificateNumbers

public java.lang.String getGiftCertificateNumbers()

Returns:

the gift certificate numbers property.

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.

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.

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.

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

preSetupGiftCertificatePaymentGroupsForOrder

public void preSetupGiftCertificatePaymentGroupsForOrder(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

validateGiftCertificateNumbers

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

Validate, wether the GiftCertificate number is valid or not

Parameters:

pRequest - a DynamoHttpServletRequest value

pResponse - a DynamoHttpServletResponse value

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs

setupGiftCertificatePaymentGroupsForOrder

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

This method Initialize and setup GiftCertificate Payment group for the order, if store credit is used, then all amount from the order detucted by the store credit, then remaining amount is detucted by gift certificates

Parameters:

pRequest - a DynamoHttpServletRequest value

pResponse - a DynamoHttpServletResponse value

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs

postSetupGiftCertificatePaymentGroupsForOrder

public void postSetupGiftCertificatePaymentGroupsForOrder(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

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

Parameters:

pRequest - a DynamoHttpServletRequest value

pResponse - a DynamoHttpServletResponse value

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs

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 gift certificates and last 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

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

preRegisterUserDuringCheckout

public void preRegisterUserDuringCheckout(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

registerUserDuringCheckout

public void registerUserDuringCheckout(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 -

pResponse -

Throws:

javax.servlet.ServletException

java.io.IOException

postRegisterUserDuringCheckout

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

Throws:

javax.servlet.ServletException

java.io.IOException

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:

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

javax.servlet.ServletException

java.io.IOException

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

This method uses the CreditCardTools to validate the credit card.

Parameters:

pRequest - - http request

pResponse - - http response

Returns:

true if success, false - otherwise

Throws:

atg.commerce.CommerceException

See Also:

CreditCardTools

validateCreditCardNicknameInput

public boolean validateCreditCardNicknameInput(atg.servlet.DynamoHttpServletRequest pRequest,
                                               atg.servlet.DynamoHttpServletResponse pResponse)

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

Parameters:

pRequest - - http request

pResponse - - http response

Returns:

true if success, false - otherwise

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

Throws:

javax.servlet.ServletException

java.io.IOException

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

handleMoveToConfirm

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

This method runs the move to confirmation pipeline chain. It also calls the preMoveToConfirm and postMoveToConfirm. The validation of inputs is in preMoveToConfirm, and the saving of information is done in postMoveToConfirm.

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

moveToConfirmExceptionHandling

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

Throws:

javax.servlet.ServletException

java.io.IOException

preMoveToConfirmExceptionHandling

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

Throws:

javax.servlet.ServletException

java.io.IOException

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

debug

protected void debug()

Logs debugging info about the form settings and payment group.