com.ibm.commerce.fulfillment.beans

Class 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 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

      • 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
      • 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
      • 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