atg.commerce.csr.order
Class CSRUpdateShippingGroupFormHandler

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.UpdateShippingGroupFormHandler
                          atg.commerce.csr.order.CSRUpdateShippingGroupFormHandler

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 CSRUpdateShippingGroupFormHandler
extends atg.commerce.order.purchase.UpdateShippingGroupFormHandler

The CSRUpdateShippingGroupFormHandler adds audit-logging capabilities to the UpdateShippingGroupFormHandler

Field Summary

static java.lang.String	CLASS_VERSION Class version string
protected CSRAgentTools	mCSRAgentTools

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

COULD_NOT_FIND_SHIPPING_GROUP_IN_CONTAINER, COULD_NOT_FIND_VALID_NICKNAME, MSG_COPY_ADDRESS, MSG_NO_SHIPPING_GROUP_IN_ORDER, MSG_ORDER_UPDATE_ERROR, MSG_VALIDATE_SHIPPING_GROUP, mShippingGroup, mShippingGroupName, mShippingGroupType, mUpdateContainer, mUpdateOrder, mUpdateShippingGroupErrorURL, mUpdateShippingGroupSuccessURL, mValidateShippingGroupChainId, mWorkingShippingGroup, NOT_VALID_SHIPPING_GROUP_NICKNAME

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

CSRUpdateShippingGroupFormHandler()

Method Summary

CSRAgentMessagingTools	getAgentMessagingTools() Returns component for sending agent messages
CSRAgentTools	getCSRAgentTools()
java.lang.String	getItemUpdateActivityType()
java.util.List	getPropertyUpdates() Returns the propertyUpdates.
java.lang.String	getTicketId() Returns the Id of the current ticket
void	postUpdateShippingGroup(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) postUpdateShippingGroup is for work that must happen after updating ShippingGroup.
void	preUpdateShippingGroup(atg.servlet.DynamoHttpServletRequest pRequest, atg.servlet.DynamoHttpServletResponse pResponse) preUpdateShippingGroup is for work that must happen before updating s ShippingGroup.
void	setAgentMessagingTools(CSRAgentMessagingTools pAgentMessagingTools) Sets the component for sending agent messages
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.
void	setPropertyUpdates(java.util.List pPropertyUpdates) Sets the propertyUpdates.

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

copyConfiguration, copyShippingGroupProperties, getShippingGroup, getShippingGroupName, getShippingGroupType, getUpdateShippingGroupErrorURL, getUpdateShippingGroupSuccessURL, getValidateShippingGroupChainId, getWorkingShippingGroup, handleUpdateShippingGroup, isUpdateContainer, isUpdateOrder, setShippingGroup, setShippingGroupByNickname, setShippingGroupName, setShippingGroupType, setUpdateContainer, setUpdateOrder, setUpdateShippingGroupErrorURL, setUpdateShippingGroupSuccessURL, setValidateShippingGroupChainId, setWorkingShippingGroup, updateContainer, updateOrder, updateShippingGroup, 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 java.lang.String CLASS_VERSION

Class version string

mCSRAgentTools

protected CSRAgentTools mCSRAgentTools

Constructor Detail

CSRUpdateShippingGroupFormHandler

public CSRUpdateShippingGroupFormHandler()

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.

getPropertyUpdates

public java.util.List getPropertyUpdates()

Returns the propertyUpdates.

Returns:

propertyUpdates

setPropertyUpdates

public void setPropertyUpdates(java.util.List pPropertyUpdates)

Sets the propertyUpdates.

Parameters:

pPropertyUpdates -

preUpdateShippingGroup

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

preUpdateShippingGroup is for work that must happen before updating s ShippingGroup. This method uses SelfManager.getShallowProperties() to figure out which properties are updated.

Overrides:

preUpdateShippingGroup in class atg.commerce.order.purchase.UpdateShippingGroupFormHandler

Parameters:

pRequest - a DynamoHttpServletRequest value

pResponse - a DynamoHttpServletResponse value

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs

postUpdateShippingGroup

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

postUpdateShippingGroup is for work that must happen after updating ShippingGroup.

Overrides:

postUpdateShippingGroup in class atg.commerce.order.purchase.UpdateShippingGroupFormHandler

Parameters:

pRequest - a DynamoHttpServletRequest value

pResponse - a DynamoHttpServletResponse value

Throws:

javax.servlet.ServletException - if an error occurs

java.io.IOException - if an error occurs

getTicketId

public java.lang.String getTicketId()

Returns the Id of the current ticket