atg.commerce.fulfillment
Class FulfillOrderFragment

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

public class FulfillOrderFragment
extends CommerceMessageImpl

This message identifies a subset of the contained order that the recipient is responsible for processing. The order may be delegated on the ShippingGroup level only, no finer level of granularity is supported. Multiple systems may receive messages of this type, but there should be no overlap in the subsets of the order that are delegated. This message cannot pass on responsibility for data at the order level, that remains with the last recipient of the SubmitOrder message. This message is provided as a means to support single orders being fulfilled by multiple independent systems.

See Also:
ShippingGroup, SubmitOrder, 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
FulfillOrderFragment()
           
 
Method Summary
 Order getOrder()
           
 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[] getShippingGroupIds()
          This property identifies which shipping groups the recipient is responsible for fulfilling.
 java.lang.String getType()
          Return the JMS message TYPE of the message
 void setOrder(Order pOrder)
          This property is the Order that should be fulfilled.
 void setOrderAsXML(java.lang.String pOrderAsXML)
           
 void setOrderId(java.lang.String pOrderId)
           
 void setShippingGroupIds(java.lang.String[] pShippingGroupIds)
           
 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

FulfillOrderFragment

public FulfillOrderFragment()
Method Detail

getOrder

public Order getOrder()

setOrder

public void setOrder(Order pOrder)
This property is the Order that should be fulfilled.

See Also:
Order

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.


setShippingGroupIds

public void setShippingGroupIds(java.lang.String[] pShippingGroupIds)

getShippingGroupIds

public java.lang.String[] getShippingGroupIds()
This property identifies which shipping groups the recipient is responsible for fulfilling. No other shipping groups should be modified by the recipient.

See Also:
ShippingGroup

getType

public java.lang.String getType()
Return the JMS message 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