atg.commerce.order.purchase
Class CommerceItemShippingInfo

java.lang.Object
  extended by atg.commerce.order.purchase.CommerceItemShippingInfo
All Implemented Interfaces:
java.io.Serializable

public class CommerceItemShippingInfo
extends java.lang.Object
implements java.io.Serializable

This helper object represents the association between a CommerceItem and its shipping information.

See Also:
Serialized Form

Field Summary
static java.lang.String CLASS_VERSION
           
protected  java.util.List<HandlingInstructionInfo> mHandlingInstructionInfos
           
static java.lang.String QUANTITY_TYPE
           
static java.lang.String QUANTITYREMAINING_TYPE
           
 
Constructor Summary
CommerceItemShippingInfo()
          Creates a new CommerceItemShippingInfo instance.
 
Method Summary
 void addHandlingInstructionInfo(HandlingInstructionInfo pHandlingInstructionInfo)
          Adds a HandlingInstructionInfo
 CommerceItem getCommerceItem()
          Return the CommerceItem property.
 java.util.List<HandlingInstructionInfo> getHandlingInstructionInfos()
           
 long getQuantity()
          Return the Quantity property.
 java.lang.String getQuantityRemainingType()
          getQuantityRemainingType is used to return the quantity remaining relationship type String.
 java.lang.String getQuantityType()
          getQuantityType is used to return the quantity relationship type String.
 java.lang.String getRelationshipType()
          Return the RelationshipType property.
 java.lang.String getShippingGroupName()
          Return the ShippingGroupName property.
 java.lang.String getShippingMethod()
          Return the ShippingMethod property.
 long getSplitQuantity()
          Return the SplitQuantity property.
 java.lang.String getSplitShippingGroupName()
          Return the SplitShippingGroupName property.
 void removeHandlingInstructionInfo(HandlingInstructionInfo pHandlingInstructionInfo)
          Removes a HandlingInstructionInfo
 void setCommerceItem(CommerceItem pCommerceItem)
          Set the CommerceItem property.
 void setHandlingInstructionInfos(java.util.List<HandlingInstructionInfo> pHandlingInstructions)
           
 void setQuantity(long pQuantity)
          Set the Quantity property.
 void setRelationshipType(java.lang.String pRelationshipType)
          Set the RelationshipType property.
 void setShippingGroupName(java.lang.String pShippingGroupName)
          Set the ShippingGroupName property.
 void setShippingMethod(java.lang.String pShippingMethod)
          Set the ShippingMethod property.
 void setSplitQuantity(long pSplitQuantity)
          Set the SplitQuantity property.
 void setSplitShippingGroupName(java.lang.String pSplitShippingGroupName)
          Set the SplitShippingGroupName property.
 java.lang.String toString()
          Method that renders the general order information in a readable string format
 
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

QUANTITY_TYPE

public static final java.lang.String QUANTITY_TYPE
See Also:
Constant Field Values

QUANTITYREMAINING_TYPE

public static final java.lang.String QUANTITYREMAINING_TYPE
See Also:
Constant Field Values

mHandlingInstructionInfos

protected java.util.List<HandlingInstructionInfo> mHandlingInstructionInfos
Constructor Detail

CommerceItemShippingInfo

public CommerceItemShippingInfo()
Creates a new CommerceItemShippingInfo instance.

Method Detail

setCommerceItem

public void setCommerceItem(CommerceItem pCommerceItem)
Set the CommerceItem property.

Parameters:
pCommerceItem - a CommerceItem value

getCommerceItem

public CommerceItem getCommerceItem()
Return the CommerceItem property.

Returns:
a CommerceItem value

setShippingMethod

public void setShippingMethod(java.lang.String pShippingMethod)
Set the ShippingMethod property.

Parameters:
pShippingMethod - a String value

getShippingMethod

public java.lang.String getShippingMethod()
Return the ShippingMethod property.

Returns:
a String value

setShippingGroupName

public void setShippingGroupName(java.lang.String pShippingGroupName)
Set the ShippingGroupName property.

Parameters:
pShippingGroupName - a String value

getShippingGroupName

public java.lang.String getShippingGroupName()
Return the ShippingGroupName property.

Returns:
a String value

setRelationshipType

public void setRelationshipType(java.lang.String pRelationshipType)
Set the RelationshipType property.

Parameters:
pRelationshipType - a String value

getRelationshipType

public java.lang.String getRelationshipType()
Return the RelationshipType property.

Returns:
a String value

setQuantity

public void setQuantity(long pQuantity)
Set the Quantity property.

Parameters:
pQuantity - a long value

getQuantity

public long getQuantity()
Return the Quantity property.

Returns:
a long value

setSplitQuantity

public void setSplitQuantity(long pSplitQuantity)
Set the SplitQuantity property.

Parameters:
pSplitQuantity - a long value

getSplitQuantity

public long getSplitQuantity()
Return the SplitQuantity property.

Returns:
a long value

setSplitShippingGroupName

public void setSplitShippingGroupName(java.lang.String pSplitShippingGroupName)
Set the SplitShippingGroupName property.

Parameters:
pSplitShippingGroupName - a String value

getSplitShippingGroupName

public java.lang.String getSplitShippingGroupName()
Return the SplitShippingGroupName property.

Returns:
a String value

getQuantityType

public java.lang.String getQuantityType()
getQuantityType is used to return the quantity relationship type String.

Returns:
a String value

getQuantityRemainingType

public java.lang.String getQuantityRemainingType()
getQuantityRemainingType is used to return the quantity remaining relationship type String.

Returns:
a String value

getHandlingInstructionInfos

public java.util.List<HandlingInstructionInfo> getHandlingInstructionInfos()

setHandlingInstructionInfos

public void setHandlingInstructionInfos(java.util.List<HandlingInstructionInfo> pHandlingInstructions)

addHandlingInstructionInfo

public void addHandlingInstructionInfo(HandlingInstructionInfo pHandlingInstructionInfo)
Adds a HandlingInstructionInfo

Parameters:
pHandlingInstructionInfo -

removeHandlingInstructionInfo

public void removeHandlingInstructionInfo(HandlingInstructionInfo pHandlingInstructionInfo)
Removes a HandlingInstructionInfo

Parameters:
pHandlingInstructionInfo -

toString

public java.lang.String toString()
Method that renders the general order information in a readable string format

Overrides:
toString in class java.lang.Object