atg.commerce.fulfillment
Class ModifyOrder

java.lang.Object
  atg.commerce.messaging.CommerceMessageImpl
      atg.commerce.fulfillment.ModifyOrder

All Implemented Interfaces:

CommerceMessage, java.io.Serializable

public class ModifyOrder
extends CommerceMessageImpl

This message is issued to request modification to an order that has already been submitted via the SubmitOrder message. The order to be modified is referenced by id only. A list of requested operations will be included that allow for modification, addition, and removal of all components that make up an order as well as the modification of order itself. This message is used to request all types of changes to an order, including: returns, cancellations (removal), change of address, change of payment method, and any other change that may require back end approval. This message is intended to be handled by a single system that can ensure safe and consistent modification of the order. If the responsibility for an order has been delegated to multiple systems via the FulfillOrderFragment message then it may be necessary for the recipient of this message to break it up into multiple ModifyOrder messages and delegate the modification operations in a similar manner. Because each operation is atomic, there is no need for a new message type to handle the delegation, simply create a ModifyOrder message with only the operations appropriate for the destination. What modifications are allowed at what stage in the order process is not defined by this specification.

See Also:

SubmitOrder, FulfillOrderFragment, Serialized Form

Field Summary

static java.lang.String	CLASS_VERSION Class version string
static java.lang.String	TYPE This is the JMS message type for the message that this class represents.

Constructor Summary

ModifyOrder()

Method Summary

Modification[]	getModifications() This method returns an array of modifications to be performed on the specified order.
java.lang.String	getOrderAsXML() This method returns the XML representation of the order.
java.lang.String	getOrderId() This method returns the id of the order that the modification pertain to.
java.lang.String	getType() return the TYPE of the message
void	setModifications(Modification[] pModifications)
void	setOrderAsXML(java.lang.String pOrderAsXML)
void	setOrderId(java.lang.String pOrderId)
java.lang.String	toString() This method returns a readable string representing the contents of this message.

Methods inherited from class atg.commerce.messaging.CommerceMessageImpl

appendBaseToString, getId, getOriginalId, getOriginalSource, getOriginalUserId, getParentSessionId, getSessionId, getSource, getUserId, setId, setOriginalId, setOriginalSource, setOriginalUserId, setParentSessionId, setSessionId, setSource, setUserId

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

TYPE

public static final java.lang.String TYPE

This is the JMS message type for the message that this class represents.

See Also:

Constant Field Values

Constructor Detail

ModifyOrder

public ModifyOrder()

Method Detail

setOrderId

public void setOrderId(java.lang.String pOrderId)

getOrderId

public java.lang.String getOrderId()

This method returns the id of the order that the modification pertain to. Only the id is passed for two reasons, because the entire Order object is not necessary and it may be up to date. The Order object is not necessary because ModifyOrder messages will not be sent until the Order has been sent out with a SubmitOrder message. The Order object that the sender of this message has may not be up to date if a ModifyOrderNotification message is in transit while this message is in transit.

setOrderAsXML

public void setOrderAsXML(java.lang.String pOrderAsXML)

getOrderAsXML

public java.lang.String getOrderAsXML()

This method returns the XML representation of the order.

setModifications

public void setModifications(Modification[] pModifications)

getModifications

public Modification[] getModifications()

This method returns an array of modifications to be performed on the specified order. The modifications will be applied in the order in which they are in the array.

getType

public java.lang.String getType()

return the TYPE of the message

Specified by:

getType in interface CommerceMessage

Overrides:

getType in class CommerceMessageImpl

toString

public java.lang.String toString()

This method returns a readable string representing the contents of this message.

Overrides:

toString in class java.lang.Object