atg.commerce.messaging

Interface CommerceMessage

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

UpdateInventory

All Known Implementing Classes:

ApprovalMessage, ApprovalMessage, ApprovalRequiredMessage, ApprovalRequiredMessage, CommerceMessageImpl, FulfillOrderFragment, GiftPurchased, ModifyOrder, ModifyOrderNotification, OrderAbandoned, PromotionClosenessMessage, PromotionUsed, ScheduledOrderMessage, SubmitOrder, TransientOrderEvent, UpdateInventoryImpl

public interface CommerceMessage
extends java.io.Serializable

This is the base interface for all the messages used in this system. Messages are the primary method of communication between the disparate fulfillment systems that might take part in the fulfillment process. Third party systems that will be sending messages into our fulfillment system need to implement this interface.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getId() This method returns the id of this message in an unspecified format.
java.lang.String	getOriginalId() Get the original message id as it came from the orignal source described above.
java.lang.String	getOriginalSource() This is the orignal source of data for this message.
java.lang.String	getOriginalUserId() This method returns the id of the end user whose action initiated this request.
java.lang.String	getParentSessionId() Returns the parent session id.
java.lang.String	getSessionId() Returns the current session id associated with the request when this message is sent in the context of an HTTP request.
java.lang.String	getSource() This method returns an arbitrary string that identifies the source of the the message.
java.lang.String	getType() returns the type of the message.
java.lang.String	getUserId() This method returns the id of the most recent end user who acted on this message, if there was one.
void	setId(java.lang.String pId) Set the id of this message.
void	setParentSessionId(java.lang.String pParentSessionId) Sets the parent session id.
void	setSessionId(java.lang.String pSessionId)
void	setSource(java.lang.String pSource) Set the source of this message.
void	setUserId(java.lang.String pUserId) Set the user id.

Field Detail

CLASS_VERSION

static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

Method Detail

getSource

java.lang.String getSource()

This method returns an arbitrary string that identifies the source of the the message. The source combined with the message id must uniquely identify a message. An example of a meaningfull source would be 'CSRUI@host.domain', this tells what software system issued the message and the host it was running on. A message with a null value for it's source is considered invalid. If the recipient of this message passes it on it must set the source to a string identifying itself and generate an Id that keeps this combination unique. This is particularly important when a message is fragmented. The user id should be either set to null or set to the id of the user that is associated with the action performed by the recipient.

setSource

void setSource(java.lang.String pSource)

Set the source of this message.

getId

java.lang.String getId()

This method returns the id of this message in an unspecified format. The combination of this id and the source of this messages must be unique. A message with a null value for it's id is considered invalid.

setId

void setId(java.lang.String pId)

Set the id of this message.

getUserId

java.lang.String getUserId()

This method returns the id of the most recent end user who acted on this message, if there was one. This field can be null and the message will still be considered valid.

setUserId

void setUserId(java.lang.String pUserId)

Set the user id.

getOriginalSource

java.lang.String getOriginalSource()

This is the orignal source of data for this message. It is important to keep the original source and id so that later references to this request can be identified. For example, it is necessary to identify the original requester of a ModifyOrder message so it can be set in a ModifyOrderNotification message. Keep in mind that the combination of original source and original id may not be unique if the message has been fragmented. This field is not used to identify what message this message is a response to, but to identify what message this message is a fragment of or a routed copy of.

getOriginalId

java.lang.String getOriginalId()

Get the original message id as it came from the orignal source described above.

getOriginalUserId

java.lang.String getOriginalUserId()

This method returns the id of the end user whose action initiated this request. This field can be null and the message will still be considered valid.

getType

java.lang.String getType()

returns the type of the message.

getSessionId

java.lang.String getSessionId()

Returns the current session id associated with the request when this message is sent in the context of an HTTP request. This field can be null and the message will still be considered valid.

setSessionId

void setSessionId(java.lang.String pSessionId)

getParentSessionId

java.lang.String getParentSessionId()

Returns the parent session id. This may be different than the request's current session id on app servers which use a separate session id for each web application. This field can be null and the message will still be considered valid.

setParentSessionId

void setParentSessionId(java.lang.String pParentSessionId)

Sets the parent session id.