java.lang.Object | +--ShippingModeAccessBean | +--com.ibm.commerce.fulfillment.beans.ShippingDataBean
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().
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
protected CommandContext commandContext
Constructor Detail |
---|
public ShippingDataBean()
Method Detail |
---|
public CommandContext getCommandContext()
public TypedProperty getRequestProperties()
public java.lang.Integer[] getShipModeIds()
public ShippingModeAccessBean[] getShipModes()
public PriceDataBean[] getShippingCharges()
public void populate() throws java.lang.Exception
java.lang.Exception
public void setAddressId(java.lang.Long anAddressId)
anAddressId
- addressIdpublic void setAddressId(java.lang.String anAddressId)
anAddressId
- addressIdpublic void setCatalogEntryId(java.lang.Long anCatalogEntryId)
anCatalogEntryId
- catalogEntryIdpublic void setCatalogEntryId(java.lang.String anCatalogEntryId)
anCatalogEntryId
- catalogEntryIdpublic void setCommandContext(CommandContext context)
context
- contextpublic void setCurrency(java.lang.String astrCurrency)
astrCurrency
- currencypublic void setStoreId(java.lang.Integer anStoreId)
anStoreId
- the store which calculation is based
on.public void setStoreId(java.lang.String asStoreId)
asStoreId
- storeIdpublic void setFulfillmentCenterId(java.lang.Integer anFulfillmentCenterId)
anFulfillmentCenterId
-
fulfillmentCenterIdpublic void setFulfillmentCenterId(java.lang.String astrFulfillmentCenterId)
astrFulfillmentCenterId
-
fulfillmentCenterIdpublic void setPrice(java.lang.String adPrice)
adPrice
- Sets pricepublic void setPrice(java.math.BigDecimal adPrice)
adPrice
- Sets pricepublic void setQuantity(java.lang.Double adQuantity)
adQuantity
- Sets quantitypublic void setQuantity(java.lang.String astrQuantity)
astrQuantity
- Sets quantitypublic void setRequestProperties(TypedProperty param)
param
- TypedPropertypublic void setUOM(java.lang.String astrUOM)
astrUOM
- Sets UOM