ShippingDataBean

java.lang.Object
- com.ibm.commerce.persistence.AbstractJpaEntityAccessBean
- - com.ibm.commerce.fulfillment.objects.ShippingModeAccessBean
  - - com.ibm.commerce.fulfillment.beans.ShippingDataBean

All Implemented Interfaces:

DataBean, InputDataBean, SmartDataBean, com.ibm.commerce.fulfillment.beans.ShippingInputDataBean, com.ibm.commerce.fulfillment.beans.ShippingSmartDataBean, java.io.Serializable
```
public class ShippingDataBean
extends ShippingModeAccessBean
implements com.ibm.commerce.fulfillment.beans.ShippingInputDataBean, com.ibm.commerce.fulfillment.beans.ShippingSmartDataBean
```
The ShippingDataBean is a special purpose databean. It is 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 (for example, 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

Fields
Modifier and Type Field and Description

static java.lang.String COPYRIGHT
The IBM copyright notice field.
- Fields inherited from interface com.ibm.commerce.beans.DataBean
  emptyString

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`COPYRIGHT` The IBM copyright notice field.

Constructor Summary

Constructors
Constructor and Description

ShippingDataBean()
This is the default constructor.

Constructors
Constructor and Description
`ShippingDataBean()` This is the default constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CommandContext`	`getCommandContext()` This method returns command context
`TypedProperty`	`getRequestProperties()` This method returns request properties
`java.lang.Integer[]`	`getShipModeIds()` This method returns a list of available shipping mode ids.
`ShippingModeAccessBean[]`	`getShipModes()` This method returns a list of available shipping mode access beans.
`ShippingModeDataBean[]`	`getShipModesData()` This method returns a list of available shipping mode data beans.
`PriceDataBean[]`	`getShippingCharges()` This method returns a list of shipping charges corresponding to the available ship modes.
`void`	`populate()` This method is used to populate the ShippingDataBean.
`void`	`setAddressId(java.lang.Long anAddressId)` This method sets address id (optional).
`void`	`setAddressId(java.lang.String anAddressId)` This method sets address id (optional).
`void`	`setCatalogEntryId(java.lang.Long anCatalogEntryId)` This method sets catalog entry id.
`void`	`setCatalogEntryId(java.lang.String anCatalogEntryId)` This method sets catalog entry id.
`void`	`setCommandContext(CommandContext context)` This method sets command context
`void`	`setCurrency(java.lang.String astrCurrency)` This method sets currency
`void`	`setFulfillmentCenterId(java.lang.Integer anFulfillmentCenterId)` This method sets fulfillment center id (optional).
`void`	`setFulfillmentCenterId(java.lang.String astrFulfillmentCenterId)` This method sets fulfillment center id (optional).
`void`	`setPrice(java.math.BigDecimal adPrice)` This method sets price (optional).
`void`	`setPrice(java.lang.String adPrice)` This method sets price (optional).
`void`	`setQuantity(java.lang.Double adQuantity)` This method sets quantity (optional).
`void`	`setQuantity(java.lang.String astrQuantity)` This method sets quantity (optional).
`void`	`setRequestProperties(TypedProperty param)` This method sets request properties.
`void`	`setStoreId(java.lang.Integer anStoreId)` This method sets store id (optional).
`void`	`setStoreId(java.lang.String asStoreId)` This method sets store id (optional).
`void`	`setUOM(java.lang.String astrUOM)` This method sets unit of measure (optional).

Methods inherited from class com.ibm.commerce.fulfillment.objects.ShippingModeAccessBean
findAll, findAllNoCache, findByOrderItemId, findByStoreEntity, findByStoreEntityIdCodeAndCarrier, findByStoreEntityIdCodeAndCarrierNoCache, findByStoreEntityNoCache, findByStorePath, findByStorePathCodeAndCarrier, findByStorePathCodeAndCarrierNoCache, findByStorePathNoCache, getCarrier, getCode, getDescription, getDescriptionNoCache, getEntity, getField1, getField2, getField2InEntityType, getMarkForDelete, getShippingModeId, getShippingModeIdInEntityType, getStoreEntityId, getStoreEntityIdInEntityType, getTrackIcon, getTrackInquiryType, getTrackName, getTrackSocksHost, getTrackSocksPort, getTrackSocksPortInEntityType, getTrackURL, instantiateEntity, setCarrier, setCode, setField1, setField2, setField2, setInitKey_shippingModeId, setInitKey_shippingModeId, setMarkForDelete, setStoreEntityId, setStoreEntityId, setTrackIcon, setTrackInquiryType, setTrackName, setTrackSocksHost, setTrackSocksPort, setTrackSocksPort, setTrackURL

Methods inherited from class com.ibm.commerce.persistence.AbstractJpaEntityAccessBean
createAccessBean, createAccessBean, createAccessBeanCollection, createAccessBeanCollection, createEntityCollection, detach, remove, setUseDataCache, toString

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - COPYRIGHT
```
public static final java.lang.String COPYRIGHT
```
    The IBM copyright notice field.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ShippingDataBean
```
public ShippingDataBean()
```
    This is the default constructor.
- Method Detail
  - getCommandContext
```
public CommandContext getCommandContext()
```
    This method returns command context
    
    Specified by:
    
    getCommandContext in interface SmartDataBean
    
    Returns:
    
    CommandContext
  - getRequestProperties
```
public TypedProperty getRequestProperties()
```
    This method returns request properties
    
    Specified by:
    
    getRequestProperties in interface InputDataBean
    
    Returns:
    
    com.ibm.commerce.datatype.TypedProperty
  - getShipModeIds
```
public java.lang.Integer[] getShipModeIds()
```
    This method returns a list of available shipping mode ids.
    
    Specified by:
    
    getShipModeIds in interface com.ibm.commerce.fulfillment.beans.ShippingSmartDataBean
    
    Returns:
    
    Integer[]
  - getShipModes
```
public ShippingModeAccessBean[] getShipModes()
```
    This method returns a list of available shipping mode access beans.
    
    Specified by:
    
    getShipModes in interface com.ibm.commerce.fulfillment.beans.ShippingSmartDataBean
    
    Returns:
    
    ShippingModeAccessBean[]
  - getShipModesData
```
public ShippingModeDataBean[] getShipModesData()
```
    This method returns a list of available shipping mode data beans.
    
    Returns:
    
    ShippingModeDataBean[] an array of ShippingModeDataBean.
  - getShippingCharges
```
public PriceDataBean[] getShippingCharges()
```
    This method returns a list of shipping charges corresponding to the available ship modes.
    
    Specified by:
    
    getShippingCharges in interface com.ibm.commerce.fulfillment.beans.ShippingSmartDataBean
    
    Returns:
    
    PriceDataBean[]
  - populate
```
public void populate()
              throws java.lang.Exception
```
    This method is used to populate the ShippingDataBean.
    
    Specified by:
    
    populate in interface SmartDataBean
    
    Throws:
    
    java.lang.Exception
  - setAddressId
```
public void setAddressId(java.lang.Long anAddressId)
```
    This method sets address id (optional).
    
    Specified by:
    
    setAddressId in interface com.ibm.commerce.fulfillment.beans.ShippingInputDataBean
    
    Parameters:
    
    anAddressId - addressId
  - setAddressId
```
public void setAddressId(java.lang.String anAddressId)
```
    This method sets address id (optional).
    
    Specified by:
    
    setAddressId in interface com.ibm.commerce.fulfillment.beans.ShippingInputDataBean
    
    Parameters:
    
    anAddressId - addressId
  - setCatalogEntryId
```
public void setCatalogEntryId(java.lang.Long anCatalogEntryId)
```
    This method sets catalog entry id.
    
    Specified by:
    
    setCatalogEntryId in interface com.ibm.commerce.fulfillment.beans.ShippingInputDataBean
    
    Parameters:
    
    anCatalogEntryId - catalogEntryId
  - setCatalogEntryId
```
public void setCatalogEntryId(java.lang.String anCatalogEntryId)
```
    This method sets catalog entry id.
    
    Specified by:
    
    setCatalogEntryId in interface com.ibm.commerce.fulfillment.beans.ShippingInputDataBean
    
    Parameters:
    
    anCatalogEntryId - catalogEntryId
  - setCommandContext
```
public void setCommandContext(CommandContext context)
```
    This method sets command context
    
    Specified by:
    
    setCommandContext in interface SmartDataBean
    
    Parameters:
    
    context - context
  - setCurrency
```
public void setCurrency(java.lang.String astrCurrency)
```
    This method sets currency
    
    Parameters:
    
    astrCurrency - currency
  - setStoreId
```
public void setStoreId(java.lang.Integer anStoreId)
```
    This method sets store id (optional).
    
    Parameters:
    
    anStoreId - the store which calculation is based on.
  - setStoreId
```
public void setStoreId(java.lang.String asStoreId)
```
    This method sets store id (optional).
    
    Parameters:
    
    asStoreId - storeId
  - setFulfillmentCenterId
```
public void setFulfillmentCenterId(java.lang.Integer anFulfillmentCenterId)
```
    This method sets fulfillment center id (optional).
    
    Specified by:
    
    setFulfillmentCenterId in interface com.ibm.commerce.fulfillment.beans.ShippingInputDataBean
    
    Parameters:
    
    anFulfillmentCenterId - fulfillmentCenterId
  - setFulfillmentCenterId
```
public void setFulfillmentCenterId(java.lang.String astrFulfillmentCenterId)
```
    This method sets fulfillment center id (optional).
    
    Specified by:
    
    setFulfillmentCenterId in interface com.ibm.commerce.fulfillment.beans.ShippingInputDataBean
    
    Parameters:
    
    astrFulfillmentCenterId - fulfillmentCenterId
  - setPrice
```
public void setPrice(java.lang.String adPrice)
```
    This method sets price (optional).
    
    Specified by:
    
    setPrice in interface com.ibm.commerce.fulfillment.beans.ShippingInputDataBean
    
    Parameters:
    
    adPrice - Sets price
  - setPrice
```
public void setPrice(java.math.BigDecimal adPrice)
```
    This method sets price (optional).
    
    Specified by:
    
    setPrice in interface com.ibm.commerce.fulfillment.beans.ShippingInputDataBean
    
    Parameters:
    
    adPrice - Sets price
  - setQuantity
```
public void setQuantity(java.lang.Double adQuantity)
```
    This method sets quantity (optional).
    
    Specified by:
    
    setQuantity in interface com.ibm.commerce.fulfillment.beans.ShippingInputDataBean
    
    Parameters:
    
    adQuantity - Sets quantity
  - setQuantity
```
public void setQuantity(java.lang.String astrQuantity)
```
    This method sets quantity (optional).
    
    Specified by:
    
    setQuantity in interface com.ibm.commerce.fulfillment.beans.ShippingInputDataBean
    
    Parameters:
    
    astrQuantity - Sets quantity
  - setRequestProperties
```
public void setRequestProperties(TypedProperty param)
```
    This method sets request properties.
    
    Specified by:
    
    setRequestProperties in interface InputDataBean
    
    Parameters:
    
    param - TypedProperty
  - setUOM
```
public void setUOM(java.lang.String astrUOM)
```
    This method sets unit of measure (optional).
    
    Specified by:
    
    setUOM in interface com.ibm.commerce.fulfillment.beans.ShippingInputDataBean
    
    Parameters:
    
    astrUOM - Sets UOM

Fields inherited from interface com.ibm.commerce.beans.DataBean

Methods inherited from class com.ibm.commerce.fulfillment.objects.ShippingModeAccessBean

Methods inherited from class com.ibm.commerce.persistence.AbstractJpaEntityAccessBean

Methods inherited from class java.lang.Object

COPYRIGHT

ShippingDataBean

getCommandContext

getRequestProperties

getShipModeIds

getShipModes

getShipModesData

getShippingCharges

populate

setAddressId

setAddressId

setCatalogEntryId

setCatalogEntryId

setCommandContext

setCurrency

setStoreId

setStoreId

setFulfillmentCenterId

setFulfillmentCenterId

setPrice

setPrice

setQuantity

setQuantity

setRequestProperties

setUOM