com.ibm.commerce.inventory.beans

Class ProductAvailabilityDataBean

  • java.lang.Object
    • com.ibm.commerce.inventory.beans.ProductAvailabilityDataBean
  • All Implemented Interfaces:
    CommandDataBean, DataBean, InputDataBean, Delegator, java.io.Serializable


    public class ProductAvailabilityDataBean
    extends java.lang.Object
    implements CommandDataBean, Delegator
    This databean represents an productAvailability object task command.

    Input parameters:

    Name Description
    SKU the SKU of the product to check
    FulfillmentCenterIds the FulfillmentCenterIds on which the product will be checked

    Output parameters:

    Name Description
    TotalQuantityOnHand the total quantity of on hand inventory
    FormattedTotalQuantityOnHand the formatted total quantity of on hand inventory
    AvailableDate the available date of expected inventory
    See Also:
    ProductAvailabilityDataBeanCmdImpl, Serialized Form
    • Field Detail

      • COPYRIGHT

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

        public static final java.lang.String PRODUCT_AVAILABILITY
        product availability
        See Also:
        Constant Field Values
      • FULFILLMENT_CENTER_IDS

        public static final java.lang.String FULFILLMENT_CENTER_IDS
        fulfillment center Id
        See Also:
        Constant Field Values
      • PRODUCT_SKU

        public static final java.lang.String PRODUCT_SKU
        Product SKU
        See Also:
        Constant Field Values
      • PRODUCT_OWNER_ID

        public static final java.lang.String PRODUCT_OWNER_ID
        the member Id of the Product Owner
        See Also:
        Constant Field Values
      • STORE_ID

        public static final java.lang.String STORE_ID
        the store Id on which we check inventory
        See Also:
        Constant Field Values
      • PRODUCT_ID

        public static final java.lang.String PRODUCT_ID
        the catentry Id of the product
        See Also:
        Constant Field Values
    • Constructor Detail

      • ProductAvailabilityDataBean

        public ProductAvailabilityDataBean()
    • Method Detail

      • getDelegate

        public Protectable getDelegate()
                                throws java.lang.Exception
        This method gets the delegate
        Specified by:
        getDelegate in interface Delegator
        Returns:
        Protectable delegate
        Throws:
        java.lang.Exception
      • setRequestProperties

        public void setRequestProperties(TypedProperty param)
                                  throws java.lang.Exception
        This method sets the request properties
        Specified by:
        setRequestProperties in interface InputDataBean
        Parameters:
        param - request properties
        Throws:
        java.lang.Exception
      • getInventoryStatus

        public java.lang.String getInventoryStatus()
        This methods gets the inventory status
        Returns:
        inventory status
      • setStoreId

        public void setStoreId(java.lang.Integer anStoreId)
        This method sets the store Id on which the inventory will be checked on the given fulfillment centers. This method is optional, the StoreId is not set, the databean will get the storeId from the command context.
        Parameters:
        anStoreId -
      • setProductId

        public void setProductId(java.lang.Integer anProductId)
        Deprecated. Since ProductId should be Long, this method is deprecated. The method public void setProductId(Long anProductId) is the alternative method.
        This method sets the product Id for which the inventory will be checked on the given fulfillment centers. This method is mandatory if the setSKU() method was not called.
        Parameters:
        anProductId -
      • setProductId

        public void setProductId(java.lang.Long anProductId)
        This method sets the product Id for which the inventory will be checked on the given fulfillment centers. This method is mandatory if the setSKU() method was not called.
        Parameters:
        anProductId -
      • setSKU

        public void setSKU(java.lang.String argSku)
        This method sets the sku (part number of the product). This method is mandatory if the setProductId() method was not called. This method will be used together with setProductOwnerId() to uniquely determine a product. This method will be ignored if setCatentryId() been called.
        Parameters:
        argSku - to set
      • setProductOwnerId

        public void setProductOwnerId(java.lang.Long anProductOwnerId)
        This method is used to set the member Id of the SKU owner. If the SKU owner was not used, we will find a suitable product according to the SKU and the store. This method will be used together with setSKU() to uniquely determine a product. This method will be ignored if setCatentryId() been called.
        Parameters:
        anProductOwnerId -
      • setFulfillmentCenterIds

        public void setFulfillmentCenterIds(java.lang.Integer[] argFulfillmentCenterIds)
        This method sets a list of fulfillment centers on which the inventory will be checked.
        Parameters:
        argFulfillmentCenterIds -
      • getFulfillmentCenterInventory

        public java.util.List getFulfillmentCenterInventory()
        This methods gets the FulfillmentCenterInventory
        Returns:
        list FulfillmentCenterInventory
      • getTotalQuantityOnHand

        public QuantityAmount getTotalQuantityOnHand()
        This method gets the total on hand quantity
        Returns:
        QuantityAmount total on hand quantity
      • getAvailableDate

        public java.sql.Timestamp getAvailableDate()
        This method gets the available time
        Returns:
        Timestamp the available time
      • getExpectedInventory

        public java.util.List getExpectedInventory()
        This method gets the expected inventory
        Returns:
        list the expected inventory
      • getFormattedTotalQuantityOnHand

        public FormattedQuantityAmountDataBean getFormattedTotalQuantityOnHand()
        This method gets the formatted QuantityAmount DataBean
        Returns:
        FormattedQuantityAmountDataBean
      • setFormattedTotalQuantityOnHand

        public void setFormattedTotalQuantityOnHand(FormattedQuantityAmountDataBean argFormattedQuantity)
        This method sets the formatted QuantityAmount DataBean
        Parameters:
        argFormattedQuantity - formatted QuantityAmount DataBean to set
      • setCommandInterfaceName

        public void setCommandInterfaceName(java.lang.String ifname)
        This method sets the command interface name. The data can be got through the specified databean command.
        Specified by:
        setCommandInterfaceName in interface CommandDataBean
        Parameters:
        ifname - The command interface name to be set
      • getCommandInterfaceName

        public java.lang.String getCommandInterfaceName()
        This method gets the command interface name that populates this data bean. The default command interfaceName is EDPPaymentInstructionsBeanCmd.
        Specified by:
        getCommandInterfaceName in interface CommandDataBean
        Returns:
        The name of the command interface
      • getRequestProperties

        public TypedProperty getRequestProperties()
        This method gets the parameters passed as part of the URL if any.
        Specified by:
        getRequestProperties in interface InputDataBean
        Returns:
        iRequestProperties The parameters passed as part of the URL if any
      • setProductAvailability

        public void setProductAvailability(com.ibm.commerce.inventory.datatypes.ProductAvailabilityType argProductAvailability)
        This method sets the productAvailability
        Parameters:
        argProductAvailability - The productAvailability to set.
      • setAvailableDate

        public void setAvailableDate(java.sql.Timestamp argAvailableDate)
        This method sets the available date
        Parameters:
        argAvailableDate - The availableDate to set.