CommerceItemShippingInfo (ATG Java API)

java.lang.Object
- 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

Fields
Modifier and Type	Field and Description
`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

Constructors
Constructor and Description

CommerceItemShippingInfo()
Creates a new CommerceItemShippingInfo instance.

Constructors
Constructor and Description
`CommerceItemShippingInfo()` Creates a new `CommerceItemShippingInfo` instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addHandlingInstructionInfo(HandlingInstructionInfo pHandlingInstructionInfo)` Adds a HandlingInstructionInfo
`CommerceItem`	`getCommerceItem()` Return the CommerceItem property.
`java.util.List<HandlingInstructionInfo>`	`getHandlingInstructionInfos()`
`long`	`getQuantity()` Return the Quantity property.
`double`	`getQuantityDerivedAsFloatingPoint()` This method will return a derived quantity value which this CommerceItemShippingInfo object represents.
`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.
`double`	`getQuantityWithFraction()` Return the QuantityWithFraction property.
`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.
`double`	`getSplitQuantityDerivedAsFloatingPoint()` This method will return a derived split quantity value which this HandlingInstructionInfo object represents.
`double`	`getSplitQuantityWithFraction()` Return the SplitQuantityWithFraction 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`	`setQuantityWithFraction(double pQuantityWithFraction)` Set the QuantityWithFraction 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`	`setSplitQuantityWithFraction(double pSplitQuantityWithFraction)` Set the SplitQuantityWithFraction 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
  - setQuantityWithFraction
```
public void setQuantityWithFraction(double pQuantityWithFraction)
```
    Set the QuantityWithFraction property.
    
    Parameters:
    
    pQuantityWithFraction - a double value
  - getQuantityWithFraction
```
public double getQuantityWithFraction()
```
    Return the QuantityWithFraction property.
    
    Returns:
    
    a double value
  - getQuantityDerivedAsFloatingPoint
```
public double getQuantityDerivedAsFloatingPoint()
```
    This method will return a derived quantity value which this CommerceItemShippingInfo object represents.
    It will decide upon the correct quantity value to return, returning the first non null value from the properties, quantityWithFraction, quantity, in that order.
    The method should be used where there is a need to know the quantity of an item but it is unknown to the caller as to which property (quantityWithFraction or quantity holds the value.
    
    Returns:
    
    a derived quantity value which this CommerceItemShippingInfo object represents
  - 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
  - setSplitQuantityWithFraction
```
public void setSplitQuantityWithFraction(double pSplitQuantityWithFraction)
```
    Set the SplitQuantityWithFraction property.
    
    Parameters:
    
    pSplitQuantityWithFraction - a double value
  - getSplitQuantityWithFraction
```
public double getSplitQuantityWithFraction()
```
    Return the SplitQuantityWithFraction property.
    
    Returns:
    
    a double value
  - getSplitQuantityDerivedAsFloatingPoint
```
public double getSplitQuantityDerivedAsFloatingPoint()
```
    This method will return a derived split quantity value which this HandlingInstructionInfo object represents.
    It will decide upon the correct split quantity value to return, returning the first non null value from the properties, splitQuantityWithFraction, splitQuantity, in that order.
    The method should be used where there is a need to know the split quantity of an item but it is unknown to the caller as to which property (splitQuantityWithFraction or splitQuantity holds the value.
    
    Returns:
    
    a derived split quantity value which this HandlingInstructionInfo object represents
  - 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

Class CommerceItemShippingInfo

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CLASS_VERSION

QUANTITY_TYPE

QUANTITYREMAINING_TYPE

mHandlingInstructionInfos

Constructor Detail

CommerceItemShippingInfo

Method Detail

setCommerceItem

getCommerceItem

setShippingMethod

getShippingMethod

setShippingGroupName

getShippingGroupName

setRelationshipType

getRelationshipType

setQuantity

getQuantity

setQuantityWithFraction

getQuantityWithFraction

getQuantityDerivedAsFloatingPoint

setSplitQuantity

getSplitQuantity

setSplitQuantityWithFraction

getSplitQuantityWithFraction

getSplitQuantityDerivedAsFloatingPoint

setSplitShippingGroupName

getSplitShippingGroupName

getQuantityType

getQuantityRemainingType

getHandlingInstructionInfos

setHandlingInstructionInfos

addHandlingInstructionInfo

removeHandlingInstructionInfo

toString