atg.commerce.fulfillment
Class GenericAdd

java.lang.Object
  atg.commerce.fulfillment.Modification
      atg.commerce.fulfillment.IdTargetModification
          atg.commerce.fulfillment.IdContainerModification
              atg.commerce.fulfillment.GenericAdd

All Implemented Interfaces:

java.io.Serializable

public class GenericAdd
extends IdContainerModification

This class is used to add a target specified by id or value to a container specified by id or value. This can be used for the following tasks:

• add item by value to shipping group by value
• add item by value to payment group by value
• add item by value to order by id
• add item by value to shipping group by id
• add item by value to payment group by id
• add item by id to shipping group by value
• add item by id to payment group by value
• add shipping group by value to order by id
• add payment group by value to order by id

Any other combination will fail, and really doesn't make sense anyway. It is an error to set both the id and value for either the target or the container. As a general rule everything should be added to the order before it is used either as a container or target in another add. For example if you are adding a new item, shipping group, and payment group, and want to add the item to both of the groups you would do the following: add the item to the order, add the shipping group to the order, add the payment group to the order, add the item to the shipping group, and finally add the item to the payment group.

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

GenericAdd()

Method Summary

java.io.Serializable	getContainerValue() This is the container within which an object of getTargetType should be added.
int	getModificationType() This is a read-only property in this implementation.
java.io.Serializable	getTargetValue() This is the object that should be added to the container.
void	setContainerValue(java.io.Serializable pContainerValue)
void	setModificationType(int pModificationType) This method sets the modification type.
void	setTargetValue(java.io.Serializable pTargetValue)
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

GenericAdd

public GenericAdd()

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 GenericAdd messages is ADD

Overrides:

getModificationType in class Modification

See Also:

Modification.ADD

setContainerValue

public void setContainerValue(java.io.Serializable pContainerValue)

getContainerValue

public java.io.Serializable getContainerValue()

This is the container within which an object of getTargetType should be added. If this is null, then use getContainerId

See Also:

IdTargetModification.getTargetType(), IdContainerModification.getContainerId()

setTargetValue

public void setTargetValue(java.io.Serializable pTargetValue)

getTargetValue

public java.io.Serializable getTargetValue()

This is the object that should be added to the container. If this is null, then use getTargetId

See Also:

IdTargetModification.getTargetId()

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