atg.commerce.fulfillment
Class SubmitOrder

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

All Implemented Interfaces:

CommerceMessage, java.io.Serializable

public class SubmitOrder
extends CommerceMessageImpl

This message will start the order fulfillment process for the order that it contains. This message is typically sent by the order entry system once a user has completed all necessary information. This message is intended to be received by only one system, and that system has ownership of the order upon receipt. Ownership means that the owning systems is the only system that can make modifications to the order or fragment of order that it owns. If a single order must be handled by multiple systems, the receiver of this message may send zero or more FulfillOrderFragment messages to other systems if it cannot or does not want to handle the entire order. If the entire order is to be delegated a SubmitOrder message should be used. Delegation of the order or a fragment of the order passes both responsibility for processing and ownership to the receiving system. It is not required that any delegation occur, and it is expected that in many implementation the recipient of this event will handle all order fulfillment tasks.

See Also:

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

SubmitOrder()

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.
RepositoryItem	getProfile()
java.lang.String	getProfileId() Returns profileId from the Profile property.
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) Set the order id of the order that should be fulfilled.
void	setProfile(RepositoryItem pProfile)
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

SubmitOrder

public SubmitOrder()

Method Detail

getProfile

public RepositoryItem getProfile()

setProfile

public void setProfile(RepositoryItem pProfile)

getProfileId

public java.lang.String getProfileId()

Returns profileId from the Profile property. if Profile property is null then null is returned.

getOrder

public Order getOrder()

setOrder

public void setOrder(Order pOrder)

This property is the Order that should be fulfilled. Setting this property also sets the orderId property to the corresponding order id, or to null if pOrder is null.

See Also:

Order

setOrderId

public void setOrderId(java.lang.String pOrderId)

Set the order id of the order that should be fulfilled. If the application calls setOrder, then calling this method is not required since the order id will be set automatically.

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.

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