atg.commerce.csr.order
Class CSRCreateHardgoodShippingGroupFormHandler

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.CreateHardgoodShippingGroupFormHandler
                          atg.commerce.csr.order.CSRCreateHardgoodShippingGroupFormHandler

All Implemented Interfaces:

atg.commerce.order.purchase.CreateShippingGroupFormHandler, atg.commerce.util.PipelineErrorHandler, atg.droplet.DropletFormHandler, atg.naming.AbsoluteNameable, atg.naming.NameContextBindingListener, atg.naming.NameContextElement, atg.naming.NameContextParentable, atg.naming.NameResolver, atg.nucleus.AdminableService, atg.nucleus.Configured, atg.nucleus.logging.ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, atg.nucleus.logging.VariableArgumentApplicationLogging, atg.nucleus.naming.ComponentNameResolver, atg.nucleus.Service, atg.nucleus.ServiceListener, java.util.EventListener

public class CSRCreateHardgoodShippingGroupFormHandler
extends atg.commerce.order.purchase.CreateHardgoodShippingGroupFormHandler

The CSRCreateHardgoodShippingGroupFormHandler class extends CreateHardgoodShippingGroupFormHandler to send agent events that will be handled by the audit-logging system

See Also:

CreateCreditCardFormHandler, PurchaseProcessFormHandler

Field Summary

static java.lang.String	CLASS_VERSION
protected CSRAgentTools	mCSRAgentTools

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

COULD_NOT_ADD_SHIPPING_ADDRESS_TO_PROFILE, COULD_NOT_FIND_SHIPPING_GROUP_OR_ADDRESS, MSG_VALIDATE_SHIPPING_GROUP

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

CSRCreateHardgoodShippingGroupFormHandler()
Creates a new CSRCreateHardgoodShippingGroupFormHandler instance.

Method Summary

protected void	createCreateHardgoodShippingGroupTicketActivity(atg.repository.RepositoryItem pTicket, java.util.Collection pPropertyUpdates) Creates the ticket activity to capture the hardgood shipping address updates to the customer profile.
CSRAgentMessagingTools	getAgentMessagingTools() Returns component for sending agent messages
CSRAgentTools	getCSRAgentTools()
java.lang.String	getItemUpdateActivityType()
atg.repository.RepositoryItem	getTicket() Returns the current ticket
java.lang.String	getTicketId() Returns the Id of the current ticket
void	postCreateHardgoodShippingGroup(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) postCreateCreditCard is for work that must happen after a new CreditCard is created.
void	setAgentMessagingTools(CSRAgentMessagingTools pAgentMessagingTools) Sets the component for sending agent messages
void	setClearShippingGroup(java.lang.String pClearFlag) After successfully adding the shipping address, if we display the add shipping address page, we need to clear out the shipping address details from the page.
void	setCSRAgentTools(CSRAgentTools pCSRAgentTools) Sets the property CSRAgentTools.
void	setItemUpdateActivityType(java.lang.String pItemUpdateActivityType) Sets the activity type used for sending the item update agent events.

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

copyConfiguration, createHardgoodShippingGroup, getAddressValidator, getContainer, getHardgoodShippingGroup, getHardgoodShippingGroupName, getHardgoodShippingGroupType, getNewHardgoodShippingGroupErrorURL, getNewHardgoodShippingGroupSuccessURL, getShippingGroupInitializers, handleNewHardgoodShippingGroup, isAddToContainer, isAddToProfile, isAssignNewShippingGroupAsDefault, isGenerateNickname, isValidateAddress, preCreateHardgoodShippingGroup, setAddressValidator, setAddToContainer, setAddToProfile, setAssignNewShippingGroupAsDefault, setContainer, setGenerateNickname, setHardgoodShippingGroup, setHardgoodShippingGroup, setHardgoodShippingGroupName, setHardgoodShippingGroupType, setNewHardgoodShippingGroupErrorURL, setNewHardgoodShippingGroupSuccessURL, setShippingGroupInitializers, setValidateAddress, validateShippingGroup

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, 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

See Also:

Constant Field Values

mCSRAgentTools

protected CSRAgentTools mCSRAgentTools

Constructor Detail

CSRCreateHardgoodShippingGroupFormHandler

public CSRCreateHardgoodShippingGroupFormHandler()

Creates a new CSRCreateHardgoodShippingGroupFormHandler instance.

Method Detail

setCSRAgentTools

public void setCSRAgentTools(CSRAgentTools pCSRAgentTools)

Sets the property CSRAgentTools.

getCSRAgentTools

public CSRAgentTools getCSRAgentTools()

Returns:

The value of the property CSRAgentTools.

setAgentMessagingTools

public void setAgentMessagingTools(CSRAgentMessagingTools pAgentMessagingTools)

Sets the component for sending agent messages

Parameters:

pAgentMessagingTools -

getAgentMessagingTools

public CSRAgentMessagingTools getAgentMessagingTools()

Returns component for sending agent messages

Returns:

AgentMessagingTools

setItemUpdateActivityType

public void setItemUpdateActivityType(java.lang.String pItemUpdateActivityType)

Sets the activity type used for sending the item update agent events.

Parameters:

pItemUpdateActivityType - the activity type used when sending the item update agent events.

getItemUpdateActivityType

public java.lang.String getItemUpdateActivityType()

Returns:

the activity type used when sending the item update agent events.

getTicketId

public java.lang.String getTicketId()

Returns the Id of the current ticket

postCreateHardgoodShippingGroup

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

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

Overrides:

postCreateHardgoodShippingGroup in class atg.commerce.order.purchase.CreateHardgoodShippingGroupFormHandler

Parameters:

pRequest - a DynamoHttpServletRequest value

pResponse - a DynamoHttpServletResponse value

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs

createCreateHardgoodShippingGroupTicketActivity

protected void createCreateHardgoodShippingGroupTicketActivity(atg.repository.RepositoryItem pTicket,
                                                               java.util.Collection pPropertyUpdates)

Creates the ticket activity to capture the hardgood shipping address updates to the customer profile.

If the given ticket is transient, it is saved to the repository.

Parameters:

pTicket - the ticket to which the activity is added.

pPropertyUpdates - collection of PropertyUpdates that details the changes made

setClearShippingGroup

public void setClearShippingGroup(java.lang.String pClearFlag)

After successfully adding the shipping address, if we display the add shipping address page, we need to clear out the shipping address details from the page. In order to clear out the shipping address, this method could be used. This method sets the shipping group to null.

getTicket

public atg.repository.RepositoryItem getTicket()

Returns the current ticket