atg.commerce.fulfillment
Class ShippingGroupUpdateFormHandler

java.lang.Object
  atg.nucleus.logging.VariableArgumentApplicationLoggingImpl
      atg.nucleus.GenericService
          atg.droplet.EmptyFormHandler
              atg.droplet.GenericFormHandler
                  atg.commerce.fulfillment.ShippingGroupUpdateFormHandler

All Implemented Interfaces:

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 ShippingGroupUpdateFormHandler
extends GenericFormHandler

This form handler is used to send a ShippingGroupUpdate modification to the fulfillment system. When the handleShippingGroupUpdate method is called, it builds a ShippingGroupUpdate modification with the order ID in the orderId property and the list of shipping group ids in the shippingGroupIdList property (You can set this property by setting the shippingGroupIdString to a space delimeted list of ids.) and sending it over the configured portName.

See Also:

ShippingGroupUpdate

Field Summary

static java.lang.String

CLASS_VERSION Class version string

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

ShippingGroupUpdateFormHandler()

Method Summary

java.lang.String	getErrorMessage() If there is an error, it will be reported here.
MessageSender	getMessageSender() The component that has been configured through patchbay to send messages.
OrderFulfillmentTools	getOrderFulfillmentTools()
java.lang.String	getOrderId() The id of the order containing the updated shipping groups.
OrderManager	getOrderManager() OrderManager is used to verify the orders existence before sending the message.
java.util.List	getShippingGroupIdList() A list of shipping group ids.
java.lang.String	getShippingGroupIdString() A space delimited string of shipping group ids.
boolean	handleShippingGroupUpdate(DynamoHttpServletRequest pRequest, DynamoHttpServletResponse pResponse) Create a ModifyOrderNotification message containing one ShippingGroupUpdate modification.
void	setErrorMessage(java.lang.String pErrorMessage)
void	setMessageSender(MessageSender pMessageSender)
void	setOrderFulfillmentTools(OrderFulfillmentTools pOrderFulfillmentTools)
void	setOrderId(java.lang.String pOrderId)
void	setOrderManager(OrderManager pOrderManager)
void	setShippingGroupIdList(java.util.List pShippingGroupIdList)
void	setShippingGroupIdString(java.lang.String pShippingGroupIdString)

Methods inherited from class atg.droplet.GenericFormHandler

addFormException, addUncheckedFormException, afterSet, beforeSet, checkFormRedirect, 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, doStartService, 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

Constructor Detail

ShippingGroupUpdateFormHandler

public ShippingGroupUpdateFormHandler()

Method Detail

setOrderManager

public void setOrderManager(OrderManager pOrderManager)

getOrderManager

public OrderManager getOrderManager()

OrderManager is used to verify the orders existence before sending the message. If null, the message will be sent with not verification.

setOrderId

public void setOrderId(java.lang.String pOrderId)

getOrderId

public java.lang.String getOrderId()

The id of the order containing the updated shipping groups.

setMessageSender

public void setMessageSender(MessageSender pMessageSender)

getMessageSender

public MessageSender getMessageSender()

The component that has been configured through patchbay to send messages.

setShippingGroupIdString

public void setShippingGroupIdString(java.lang.String pShippingGroupIdString)

getShippingGroupIdString

public java.lang.String getShippingGroupIdString()

A space delimited string of shipping group ids.

setShippingGroupIdList

public void setShippingGroupIdList(java.util.List pShippingGroupIdList)

getShippingGroupIdList

public java.util.List getShippingGroupIdList()

A list of shipping group ids.

setOrderFulfillmentTools

public void setOrderFulfillmentTools(OrderFulfillmentTools pOrderFulfillmentTools)

getOrderFulfillmentTools

public OrderFulfillmentTools getOrderFulfillmentTools()

setErrorMessage

public void setErrorMessage(java.lang.String pErrorMessage)

getErrorMessage

public java.lang.String getErrorMessage()

If there is an error, it will be reported here.

handleShippingGroupUpdate

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

Create a ModifyOrderNotification message containing one ShippingGroupUpdate modification. Use messageSender to send it to the rest of DCS.

Throws:

javax.servlet.ServletException

java.io.IOException