com.ibm.commerce.fulfillment.beans
Class ShippingDataBean

java.lang.Object
  |
  +--ShippingModeAccessBean
        |
        +--com.ibm.commerce.fulfillment.beans.ShippingDataBean

public class ShippingDataBean
extends ShippingModeAccessBean

The ShippingDataBean is a special purpose databean designed to estimate the shipping charge of a catalog entry for each of the available shipping modes in the absence of an order. Note: to simply retrieve the list of available shipping modes, it is strongly recommended that the ShippingModeDataBean or the ShippingHelper be used instead. The following input parameters are mandatory: commandContext, catalogEntryId. Other input parameters (e.g. addressId) are optional, but will improve the accuracy of the shipping charge estimates. The methods getShipModeIds() and getShipModes() will return the list of shipping modes that return non-null shipping charge estimates after the databean has been populated. The method getShippingCharges() will return the list of shipping charge estimates corresponding to the list of shipping modes returned by getShippingModeIds() or getShippingModes().

See Also:
Serialized Form

Field Summary
protected  CommandContext commandContext
          command context
static java.lang.String COPYRIGHT
          The internal copyright field.
 
Constructor Summary
ShippingDataBean()
          ShippingDataBean constructor comment.
 
Method Summary
  CommandContext getCommandContext()
          Returns command context
  TypedProperty getRequestProperties()
          Returns request properties
 java.lang.Integer[] getShipModeIds()
          Return a list of available shipping mode ids.
 ShippingModeAccessBean[] getShipModes()
          Return a list of available shipping mode access beans.
  PriceDataBean[] getShippingCharges()
          Return a list of shipping charges corresponding to the available ship modes.
 void populate()
          Retrieves data from the database
 void setAddressId(java.lang.Long anAddressId)
          set address id (optional).
 void setAddressId(java.lang.String anAddressId)
          set address id (optional).
 void setCatalogEntryId(java.lang.Long anCatalogEntryId)
          set catalog entry id.
 void setCatalogEntryId(java.lang.String anCatalogEntryId)
          set catalog entry id.
 void setCommandContext( CommandContext context)
          Sets command context
 void setCurrency(java.lang.String astrCurrency)
          Sets currency
 void setFulfillmentCenterId(java.lang.Integer anFulfillmentCenterId)
          set fulfillment center id (optional).
 void setFulfillmentCenterId(java.lang.String astrFulfillmentCenterId)
          set fulfillment center id (optional).
 void setPrice(java.math.BigDecimal adPrice)
          set price (optional).
 void setPrice(java.lang.String adPrice)
          set price (optional).
 void setQuantity(java.lang.Double adQuantity)
          set quantity (optional).
 void setQuantity(java.lang.String astrQuantity)
          set quantity (optional).
 void setRequestProperties( TypedProperty param)
          Sets request properties
 void setStoreId(java.lang.Integer anStoreId)
          set store id (optional).
 void setStoreId(java.lang.String asStoreId)
          set store id (optional).
 void setUOM(java.lang.String astrUOM)
          set unit of measure (optional).
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail
public static final java.lang.String COPYRIGHT
The internal copyright field.
See Also:
Constant Field Values

commandContext

protected CommandContext commandContext
command context
Constructor Detail

ShippingDataBean

public ShippingDataBean()
ShippingDataBean constructor comment.
Method Detail

getCommandContext

public CommandContext getCommandContext()
Returns command context
Returns:

getRequestProperties

public TypedProperty getRequestProperties()
Returns request properties
Returns:

getShipModeIds

public java.lang.Integer[] getShipModeIds()
Return a list of available shipping mode ids.
Returns:

getShipModes

public ShippingModeAccessBean[] getShipModes()
Return a list of available shipping mode access beans.
Returns:

getShippingCharges

public PriceDataBean[] getShippingCharges()
Return a list of shipping charges corresponding to the available ship modes.
Returns:

populate

public void populate()
              throws java.lang.Exception
Retrieves data from the database
Throws:
java.lang.Exception

setAddressId

public void setAddressId(java.lang.Long anAddressId)
set address id (optional).
Parameters:
anAddressId - addressId

setAddressId

public void setAddressId(java.lang.String anAddressId)
set address id (optional).
Parameters:
anAddressId - addressId

setCatalogEntryId

public void setCatalogEntryId(java.lang.Long anCatalogEntryId)
set catalog entry id.
Parameters:
anCatalogEntryId - catalogEntryId

setCatalogEntryId

public void setCatalogEntryId(java.lang.String anCatalogEntryId)
set catalog entry id.
Parameters:
anCatalogEntryId - catalogEntryId

setCommandContext

public void setCommandContext(CommandContext context)
Sets command context
Parameters:
context - context

setCurrency

public void setCurrency(java.lang.String astrCurrency)
Sets currency
Parameters:
astrCurrency - currency

setStoreId

public void setStoreId(java.lang.Integer anStoreId)
set store id (optional).
Parameters:
anStoreId - the store which calculation is based on.

setStoreId

public void setStoreId(java.lang.String asStoreId)
set store id (optional).
Parameters:
asStoreId - storeId

setFulfillmentCenterId

public void setFulfillmentCenterId(java.lang.Integer anFulfillmentCenterId)
set fulfillment center id (optional).
Parameters:
anFulfillmentCenterId - fulfillmentCenterId

setFulfillmentCenterId

public void setFulfillmentCenterId(java.lang.String astrFulfillmentCenterId)
set fulfillment center id (optional).
Parameters:
astrFulfillmentCenterId - fulfillmentCenterId

setPrice

public void setPrice(java.lang.String adPrice)
set price (optional).
Parameters:
adPrice - Sets price

setPrice

public void setPrice(java.math.BigDecimal adPrice)
set price (optional).
Parameters:
adPrice - Sets price

setQuantity

public void setQuantity(java.lang.Double adQuantity)
set quantity (optional).
Parameters:
adQuantity - Sets quantity

setQuantity

public void setQuantity(java.lang.String astrQuantity)
set quantity (optional).
Parameters:
astrQuantity - Sets quantity

setRequestProperties

public void setRequestProperties(TypedProperty param)
Sets request properties
Parameters:
param - TypedProperty

setUOM

public void setUOM(java.lang.String astrUOM)
set unit of measure (optional).
Parameters:
astrUOM - Sets UOM