atg.commerce.fulfillment
Class Modification

java.lang.Object
  atg.commerce.fulfillment.Modification

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

IdTargetModification, PaymentGroupUpdate, ShippingGroupUpdate

public abstract class Modification
extends java.lang.Object
implements java.io.Serializable

This is the base class for all forms of modifications that can be applied to an Order through the ModifyOrder message and all results returned with the ModifyOrderNotification.

See Also:

Serialized Form

Field Summary

static int	ADD This constant is the modification type add, this means add a new object.
static java.lang.String	CLASS_VERSION Class version string
static int	PAYMENT_GROUP_UPDATE This constant is the modification type update.
static int	REMOVE This constant is the modification type remove, this means remove an existing object.
static int	SHIPPING_GROUP_UPDATE This constant is the modification type update.
static int	STATUS_FAILED This modification failed, there may be more detail in the text.
static int	STATUS_PENDING This modification has not been processed yet.
static int	STATUS_SUCCESS This modification was complete successfuly, there may still be more detail in the text.
static int	TARGET_ITEM This constant is used to identify the target of a modification as an item.
static int	TARGET_ORDER This constant is used to identify the target of a modification as an order.
static int	TARGET_PAYMENT_GROUP This constant is used to identify the target of a modification as a payment group.
static int	TARGET_RELATIONSHIP This constant is used to identify the target of a modification as a Relationship
static int	TARGET_SHIPPING_GROUP This constant is used to identify the target of a modification as a shipping group.
static int	UPDATE This constant is the modification type update, this means modify the value of one or more properties of an object.

Constructor Summary

Modification()

Method Summary

java.lang.String	getModificationId() This returns the id of this modification.
int	getModificationStatus() The status of this modification.
java.lang.String	getModificationStatusText() Additional text that may qualify the status code.
int	getModificationType() This method returns the type of modification that is to be performed.
java.lang.String	setModificationId(java.lang.String pModificationId) Sets the id of this modification.
void	setModificationStatus(int pModificationStatus) Sets the status of this modification.
void	setModificationStatusText(java.lang.String pModificationStatusText) Additional text that may qualify the status code.
void	setModificationType(int pModificationType) This method sets the modification type.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

ADD

public static final int ADD

This constant is the modification type add, this means add a new object. This can be a user requested event or a backend event causing changes to the order.

See Also:

Constant Field Values

REMOVE

public static final int REMOVE

This constant is the modification type remove, this means remove an existing object. This can be the result of a user requesting cancelation or a backend event causing changes to the order.

See Also:

Constant Field Values

UPDATE

public static final int UPDATE

This constant is the modification type update, this means modify the value of one or more properties of an object. This can be the result of a user requesting a change or a backend event causing changes to the order.

See Also:

Constant Field Values

SHIPPING_GROUP_UPDATE

public static final int SHIPPING_GROUP_UPDATE

This constant is the modification type update. This means reprocess the shipping groups within the appropriate fulfillers.

See Also:

Constant Field Values

PAYMENT_GROUP_UPDATE

public static final int PAYMENT_GROUP_UPDATE

This constant is the modification type update. This means reprocess the shipping groups within the appropriate fulfillers.

See Also:

Constant Field Values

TARGET_ITEM

public static final int TARGET_ITEM

This constant is used to identify the target of a modification as an item.

See Also:

Constant Field Values

TARGET_SHIPPING_GROUP

public static final int TARGET_SHIPPING_GROUP

This constant is used to identify the target of a modification as a shipping group.

See Also:

Constant Field Values

TARGET_PAYMENT_GROUP

public static final int TARGET_PAYMENT_GROUP

This constant is used to identify the target of a modification as a payment group.

See Also:

Constant Field Values

TARGET_ORDER

public static final int TARGET_ORDER

This constant is used to identify the target of a modification as an order.

See Also:

Constant Field Values

TARGET_RELATIONSHIP

public static final int TARGET_RELATIONSHIP

This constant is used to identify the target of a modification as a Relationship

See Also:

Constant Field Values

STATUS_PENDING

public static final int STATUS_PENDING

This modification has not been processed yet.

See Also:

Constant Field Values

STATUS_SUCCESS

public static final int STATUS_SUCCESS

This modification was complete successfuly, there may still be more detail in the text.

See Also:

Constant Field Values

STATUS_FAILED

public static final int STATUS_FAILED

This modification failed, there may be more detail in the text.

See Also:

Constant Field Values

Constructor Detail

Modification

public Modification()

Method Detail

getModificationId

public java.lang.String getModificationId()

This returns the id of this modification. This id must be unique within this message, this means that the combination of the messages original source, messages original id, and modification id must be unique.

setModificationId

public java.lang.String setModificationId(java.lang.String pModificationId)

Sets the id of this modification.

getModificationType

public int getModificationType()

This method returns the type of modification that is to be performed.

setModificationType

public void setModificationType(int pModificationType)

This method sets the modification type.

getModificationStatus

public int getModificationStatus()

The status of this modification. When the request is made this is set to STATUS_PENDING, once it has been handled this will be set to one of the other STATUS_* values defined in this class.

setModificationStatus

public void setModificationStatus(int pModificationStatus)

Sets the status of this modification.

getModificationStatusText

public java.lang.String getModificationStatusText()

Additional text that may qualify the status code.

setModificationStatusText

public void setModificationStatusText(java.lang.String pModificationStatusText)

Additional text that may qualify the status code.