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.
Modifier and Type | Field and Description |
---|---|
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 and Description |
---|
Modification() |
Modifier and Type | Method and Description |
---|---|
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.
|
public static java.lang.String CLASS_VERSION
public static final int ADD
public static final int REMOVE
public static final int UPDATE
public static final int SHIPPING_GROUP_UPDATE
public static final int PAYMENT_GROUP_UPDATE
public static final int TARGET_ITEM
public static final int TARGET_SHIPPING_GROUP
public static final int TARGET_PAYMENT_GROUP
public static final int TARGET_ORDER
public static final int TARGET_RELATIONSHIP
public static final int STATUS_PENDING
public static final int STATUS_SUCCESS
public static final int STATUS_FAILED
public java.lang.String getModificationId()
public java.lang.String setModificationId(java.lang.String pModificationId)
public int getModificationType()
public void setModificationType(int pModificationType)
public int getModificationStatus()
public void setModificationStatus(int pModificationStatus)
public java.lang.String getModificationStatusText()
public void setModificationStatusText(java.lang.String pModificationStatusText)