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.
SubmitOrder
,
FulfillOrderFragment
,
Serialized FormModifier and Type | Field and Description |
---|---|
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 and Description |
---|
ModifyOrder() |
Modifier and Type | Method and Description |
---|---|
Modification[] |
getModifications()
This method returns an array of modifications to be performed on the specified 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 |
setOrderId(java.lang.String pOrderId) |
java.lang.String |
toString()
This method returns a readable string representing the contents of this message.
|
appendBaseToString, getAttribute, getAttributes, getId, getOriginalId, getOriginalSource, getOriginalUserId, getParentSessionId, getSessionId, getSiteId, getSource, getUserId, setAttribute, setId, setOriginalId, setOriginalSource, setOriginalUserId, setParentSessionId, setSessionId, setSiteId, setSource, setUserId
public static java.lang.String CLASS_VERSION
public static final java.lang.String TYPE
public void setOrderId(java.lang.String pOrderId)
public java.lang.String getOrderId()
public void setModifications(Modification[] pModifications)
public Modification[] getModifications()
public java.lang.String getType()
getType
in interface atg.dms.forward.ForwardMessage
getType
in class atg.dms.forward.ForwardMessageImpl
public java.lang.String toString()
toString
in class java.lang.Object