public class CommerceItemShippingInfo
extends java.lang.Object
implements java.io.Serializable
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 and Description |
---|
CommerceItemShippingInfo()
Creates a new
CommerceItemShippingInfo instance. |
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
|
public static java.lang.String CLASS_VERSION
public static final java.lang.String QUANTITY_TYPE
public static final java.lang.String QUANTITYREMAINING_TYPE
protected java.util.List<HandlingInstructionInfo> mHandlingInstructionInfos
public CommerceItemShippingInfo()
CommerceItemShippingInfo
instance.public void setCommerceItem(CommerceItem pCommerceItem)
pCommerceItem
- a CommerceItem
valuepublic CommerceItem getCommerceItem()
CommerceItem
valuepublic void setShippingMethod(java.lang.String pShippingMethod)
pShippingMethod
- a String
valuepublic java.lang.String getShippingMethod()
String
valuepublic void setShippingGroupName(java.lang.String pShippingGroupName)
pShippingGroupName
- a String
valuepublic java.lang.String getShippingGroupName()
String
valuepublic void setRelationshipType(java.lang.String pRelationshipType)
pRelationshipType
- a String
valuepublic java.lang.String getRelationshipType()
String
valuepublic void setQuantity(long pQuantity)
pQuantity
- a long
valuepublic long getQuantity()
long
valuepublic void setQuantityWithFraction(double pQuantityWithFraction)
pQuantityWithFraction
- a double
valuepublic double getQuantityWithFraction()
double
valuepublic double getQuantityDerivedAsFloatingPoint()
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.
public void setSplitQuantity(long pSplitQuantity)
pSplitQuantity
- a long
valuepublic long getSplitQuantity()
long
valuepublic void setSplitQuantityWithFraction(double pSplitQuantityWithFraction)
pSplitQuantityWithFraction
- a double
valuepublic double getSplitQuantityWithFraction()
double
valuepublic double getSplitQuantityDerivedAsFloatingPoint()
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.
public void setSplitShippingGroupName(java.lang.String pSplitShippingGroupName)
pSplitShippingGroupName
- a String
valuepublic java.lang.String getSplitShippingGroupName()
String
valuepublic java.lang.String getQuantityType()
getQuantityType
is used to return the quantity relationship type String.String
valuepublic java.lang.String getQuantityRemainingType()
getQuantityRemainingType
is used to return the quantity remaining
relationship type String.String
valuepublic java.util.List<HandlingInstructionInfo> getHandlingInstructionInfos()
public void setHandlingInstructionInfos(java.util.List<HandlingInstructionInfo> pHandlingInstructions)
public void addHandlingInstructionInfo(HandlingInstructionInfo pHandlingInstructionInfo)
pHandlingInstructionInfo
- public void removeHandlingInstructionInfo(HandlingInstructionInfo pHandlingInstructionInfo)
pHandlingInstructionInfo
- public java.lang.String toString()
toString
in class java.lang.Object