atg.commerce.order.purchase
Class CreateCreditCardFormHandler

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

All Implemented Interfaces:

CreatePaymentGroupFormHandler, atg.commerce.util.PipelineErrorHandler, DropletFormHandler, NameContextBindingListener, NameContextElement, NameResolver, AdminableService, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, atg.nucleus.logging.VariableArgumentApplicationLogging, ComponentNameResolver, Service, ServiceListener, java.util.EventListener

public class CreateCreditCardFormHandler
extends PurchaseProcessFormHandler
implements CreatePaymentGroupFormHandler

The CreateCreditCardFormHandler class is used to create a CreditCard PaymentGroup. This CreditCard is optionally added to a PaymentGroupMapContainer and copied to the Profile.

See Also:

GenericFormHandler, PurchaseProcessFormHandler

Field Summary

static java.lang.String

CLASS_VERSION

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

CreateCreditCardFormHandler()
Creates a new CreateCreditCardFormHandler instance.

Method Summary

protected void	copyConfiguration() Copy property settings from the optional PurchaseProcessConfiguration component.
void	createCreditCard(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) createCreditCard creates a new CreditCard.
PaymentGroupMapContainer	getContainer() Return the Container property.
CreditCard	getCreditCard() Return the CreditCard property.
java.lang.String	getCreditCardName() Return the CreditCardName property.
java.lang.String	getCreditCardType() Return the CreditCardType property.
java.lang.String	getNewCreditCardErrorURL() Return the NewCreditCardErrorURL property.
java.lang.String	getNewCreditCardSuccessURL() Return the NewCreditCardSuccessURL property.
boolean	handleNewCreditCard(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) handleNewCreditCard is used to create a new CreditCard.
boolean	isAddToContainer() Return the AddToContainer property.
boolean	isAssignNewCreditCardAsDefault()
boolean	isCopyToProfile() Return the CopyToProfile property.
boolean	isGenerateNickname()
boolean	isValidateCreditCard()
void	postCreateCreditCard(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) postCreateCreditCard is for work that must happen after a new CreditCard is created.
void	preCreateCreditCard(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) preCreateCreditCard is for work that must happen before a new CreditCard is created.
void	setAddToContainer(boolean pAddToContainer) Set the AddToContainer property.
void	setAssignNewCreditCardAsDefault(boolean pAssignNewCreditCardAsDefault)
void	setContainer(PaymentGroupMapContainer pContainer) Set the Container property.
void	setCopyToProfile(boolean pCopyToProfile) Set the CopyToProfile property.
void	setCreditCard(CreditCard pCreditCard) Set the CreditCard property.
void	setCreditCardName(java.lang.String pCreditCardName) Set the CreditCardName property.
void	setCreditCardType(java.lang.String pCreditCardType) Set the CreditCardType property.
void	setGenerateNickname(boolean pGenerateNickname)
void	setNewCreditCardErrorURL(java.lang.String pNewCreditCardErrorURL) Set the NewCreditCardErrorURL property.
void	setNewCreditCardSuccessURL(java.lang.String pNewCreditCardSuccessURL) Set the NewCreditCardSuccessURL property.
void	setValidateCreditCard(boolean pValidateCreditCard)
void	validateCreditCard(CreditCard pCreditCard, DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) This method validates the credit card and if there is any errors adds the form exceptions.

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

acquireTransactionLock, acquireTransactionLock, afterSet, beforeSet, checkFormRedirect, commitTransaction, 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

Constructor Detail

CreateCreditCardFormHandler

public CreateCreditCardFormHandler()

Creates a new CreateCreditCardFormHandler instance.

Method Detail

setAddToContainer

public void setAddToContainer(boolean pAddToContainer)

Set the AddToContainer property.

Parameters:

pAddToContainer - a boolean value

isAddToContainer

public boolean isAddToContainer()

Return the AddToContainer property.

Returns:

a boolean value

setCopyToProfile

public void setCopyToProfile(boolean pCopyToProfile)

Set the CopyToProfile property.

Parameters:

pCopyToProfile - a boolean value

isCopyToProfile

public boolean isCopyToProfile()

Return the CopyToProfile property.

Returns:

a boolean value

setContainer

public void setContainer(PaymentGroupMapContainer pContainer)

Set the Container property.

Parameters:

pContainer - a PaymentGroupMapContainer value

getContainer

public PaymentGroupMapContainer getContainer()

Return the Container property.

Returns:

a PaymentGroupMapContainer value

setCreditCardName

public void setCreditCardName(java.lang.String pCreditCardName)

Set the CreditCardName property.

Parameters:

pCreditCardName - a String value

getCreditCardName

public java.lang.String getCreditCardName()

Return the CreditCardName property.

Returns:

a String value

setCreditCardType

public void setCreditCardType(java.lang.String pCreditCardType)

Set the CreditCardType property.

Parameters:

pCreditCardType - a String value

getCreditCardType

public java.lang.String getCreditCardType()

Return the CreditCardType property.

Returns:

a String value

setNewCreditCardSuccessURL

public void setNewCreditCardSuccessURL(java.lang.String pNewCreditCardSuccessURL)

Set the NewCreditCardSuccessURL property.

Parameters:

pNewCreditCardSuccessURL - a String value

getNewCreditCardSuccessURL

public java.lang.String getNewCreditCardSuccessURL()

Return the NewCreditCardSuccessURL property.

Returns:

a String value

setNewCreditCardErrorURL

public void setNewCreditCardErrorURL(java.lang.String pNewCreditCardErrorURL)

Set the NewCreditCardErrorURL property.

Parameters:

pNewCreditCardErrorURL - a String value

getNewCreditCardErrorURL

public java.lang.String getNewCreditCardErrorURL()

Return the NewCreditCardErrorURL property.

Returns:

a String value

setCreditCard

public void setCreditCard(CreditCard pCreditCard)

Set the CreditCard property.

Parameters:

pCreditCard - a CreditCard value

getCreditCard

public CreditCard getCreditCard()

Return the CreditCard property. This method exposes the CreditCard as a JavaBean property so that it may be edited directly from a .jhtml page. If this is null, then the PaymentGroupManager is used to create a new CreditCard.

Returns:

a CreditCard value

isAssignNewCreditCardAsDefault

public boolean isAssignNewCreditCardAsDefault()

Returns:

the assignNewCreditCardAsDefault

setAssignNewCreditCardAsDefault

public void setAssignNewCreditCardAsDefault(boolean pAssignNewCreditCardAsDefault)

Parameters:

pAssignNewCreditCardAsDefault - The assignNewCreditCardAsDefault to set.

isValidateCreditCard

public boolean isValidateCreditCard()

Returns:

the validateCreditCard

setValidateCreditCard

public void setValidateCreditCard(boolean pValidateCreditCard)

Parameters:

pValidateCreditCard - The validateCreditCard to set.

isGenerateNickname

public boolean isGenerateNickname()

Returns:

the generateNickname

setGenerateNickname

public void setGenerateNickname(boolean pGenerateNickname)

Parameters:

pGenerateNickname - The generateNickname to set.

handleNewCreditCard

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

handleNewCreditCard is used to create a new CreditCard.

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

preCreateCreditCard

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

preCreateCreditCard is for work that must happen before a new CreditCard is created.

Parameters:

pRequest - a DynamoHttpServletRequest value

pResponse - a DynamoHttpServletResponse value

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs

postCreateCreditCard

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

postCreateCreditCard is for work that must happen after a new CreditCard is created.

Parameters:

pRequest - a DynamoHttpServletRequest value

pResponse - a DynamoHttpServletResponse value

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs

createCreditCard

public void createCreditCard(DynamoHttpServletRequest pRequest,
                             DynamoHttpServletResponse pResponse)

createCreditCard creates a new CreditCard. The CreditCardType property gives the type of PaymentGroup to create. The CreditCardName property gives the name of the new PaymentGroup, as it will be referenced in the PaymentGroupMapContainer. If isAddToContainer is true then the CreditCard is added to the PaymentGroupMapContainer and made the default PaymentGroup. If isCopyToProfile is true then the CreditCard is copied to the Profile.

Parameters:

pRequest - a DynamoHttpServletRequest value

pResponse - a DynamoHttpServletResponse value

See Also:

atg.commerce.profile.CommerceProfileTools.getUniqueCreditCardNickname()

validateCreditCard

public void validateCreditCard(CreditCard pCreditCard,
                               DynamoHttpServletRequest pRequest,
                               DynamoHttpServletResponse pResponse)
                        throws javax.servlet.ServletException,
                               java.io.IOException

This method validates the credit card and if there is any errors adds the form exceptions.

Parameters:

pCreditCard -

Throws:

java.io.IOException

javax.servlet.ServletException

copyConfiguration

protected void copyConfiguration()

Copy property settings from the optional PurchaseProcessConfiguration component. Property values that were configured locally are preserved. Configures the following properties (if not already set):

• container (from paymentGroupMapContainer)

Overrides:

copyConfiguration in class PurchaseProcessFormHandler