atg.commerce.fulfillment
Class GenericRemove

java.lang.Object
  extended by atg.commerce.fulfillment.Modification
      extended by atg.commerce.fulfillment.IdTargetModification
          extended by atg.commerce.fulfillment.IdContainerModification
              extended by atg.commerce.fulfillment.GenericRemove
All Implemented Interfaces:
java.io.Serializable

public class GenericRemove
extends IdContainerModification

This class is used to remove an object specified by id from a container specified by id. If an item, shipping group or payment group is removed from an order, it is removed from any relationships it has with it's peers. For example if an item is removed from an order it is also implicitly removed from all shipping groups and payment groups it was in.

See Also:
Serialized Form

Field Summary
static java.lang.String CLASS_VERSION
          Class version string
 
Fields inherited from class atg.commerce.fulfillment.Modification
ADD, PAYMENT_GROUP_UPDATE, REMOVE, SHIPPING_GROUP_UPDATE, STATUS_FAILED, STATUS_PENDING, STATUS_SUCCESS, TARGET_ITEM, TARGET_ORDER, TARGET_PAYMENT_GROUP, TARGET_RELATIONSHIP, TARGET_SHIPPING_GROUP, UPDATE
 
Constructor Summary
GenericRemove()
           
 
Method Summary
 int getModificationType()
          This is a read-only property in this implementation.
 void setModificationType(int pModificationType)
          This method sets the modification type.
 java.lang.String toString()
          This method returns a readable string representing the contents of this message.
 
Methods inherited from class atg.commerce.fulfillment.IdContainerModification
getContainerId, getContainerType, setContainerId, setContainerType
 
Methods inherited from class atg.commerce.fulfillment.IdTargetModification
getTargetId, getTargetType, setTargetId, setTargetType
 
Methods inherited from class atg.commerce.fulfillment.Modification
getModificationId, getModificationStatus, getModificationStatusText, setModificationId, setModificationStatus, setModificationStatusText
 
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

Constructor Detail

GenericRemove

public GenericRemove()
Method Detail

setModificationType

public void setModificationType(int pModificationType)
Description copied from class: Modification
This method sets the modification type.

Overrides:
setModificationType in class Modification

getModificationType

public int getModificationType()
This is a read-only property in this implementation. The type of all GenericRemove messages is REMOVE

Overrides:
getModificationType in class Modification
See Also:
Modification.REMOVE

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