atg.commerce.fulfillment
Class ModifyOrderNotification

java.lang.Object
  extended by atg.commerce.messaging.CommerceMessageImpl
      extended by atg.commerce.fulfillment.ModifyOrderNotification
All Implemented Interfaces:
CommerceMessage, java.io.Serializable

public class ModifyOrderNotification
extends CommerceMessageImpl

This interface corresponds to the ModifyOrderNotification message. This message may be the result of a ModifyOrder message or spontaneously generated as the result of changes to the order as part of normal order processing. If this message is the reult of a ModifyOrder message, the modifyOrderSource and modifyOrderId will be set to the values that were stored in the ModifyOrder messages originalSource and originalId properties.

See Also:
Serialized Form

Field Summary
static java.lang.String CLASS_VERSION
          Class version string
static java.lang.String TYPE
           
 
Constructor Summary
ModifyOrderNotification()
           
 
Method Summary
 Modification[] getModifications()
          This method returns an array of modifications that have been processed.
 java.lang.String getModifyOrderId()
          The id of the message this is a response to, null if this is not a response.
 java.lang.String getModifyOrderSource()
          The id of the message this is a response to, null if this is not a response.
 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 modifications pertain to.
 java.lang.String getType()
          return the TYPE of the message
 void setModifications(Modification[] pModifications)
          This method sets the array of completed modifications.
 void setModifyOrderId(java.lang.String pModifyOrderId)
          The id of the message this is a response to, null if this is not a response.
 void setModifyOrderSource(java.lang.String pModifyOrderSource)
          The source of the message this is a response to, null if this is not a response.
 void setOrderAsXML(java.lang.String pOrderAsXML)
           
 void setOrderId(java.lang.String pOrderId)
          This method set the id of the Order that this message pertains to.
 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
See Also:
Constant Field Values
Constructor Detail

ModifyOrderNotification

public ModifyOrderNotification()
Method Detail

setOrderId

public void setOrderId(java.lang.String pOrderId)
This method set the id of the Order that this message pertains to.


getOrderId

public java.lang.String getOrderId()
This method returns the id of the order that the modifications pertain to.


setOrderAsXML

public void setOrderAsXML(java.lang.String pOrderAsXML)

getOrderAsXML

public java.lang.String getOrderAsXML()
This method returns the XML representation of the order.


setModifyOrderSource

public void setModifyOrderSource(java.lang.String pModifyOrderSource)
The source of the message this is a response to, null if this is not a response.


getModifyOrderSource

public java.lang.String getModifyOrderSource()
The id of the message this is a response to, null if this is not a response.


setModifyOrderId

public void setModifyOrderId(java.lang.String pModifyOrderId)
The id of the message this is a response to, null if this is not a response.


getModifyOrderId

public java.lang.String getModifyOrderId()
The id of the message this is a response to, null if this is not a response.


setModifications

public void setModifications(Modification[] pModifications)
This method sets the array of completed modifications.


getModifications

public Modification[] getModifications()
This method returns an array of modifications that have been processed. Each modifications status flag will be set to indicate how the modification was completed.


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