com.ibm.commerce.inventory.commands

Interface ManageInventoryCmd

  • All Superinterfaces:
    com.ibm.websphere.command.CacheableCommand, com.ibm.commerce.command.CacheableECCommand, com.ibm.websphere.command.Command, com.ibm.websphere.command.CommandCaller, ECCommand, java.io.Serializable, com.ibm.websphere.command.TargetableCommand, TaskCommand
    All Known Implementing Classes:
    ManageInventoryCmdImpl


    public interface ManageInventoryCmd
    extends TaskCommand
    This Inventory task command is used to manage inventory in accelerator.
    It acts as the single interface for all inventory operations. The default implementation of this command is ManageInventoryCmdImpl.
    See Also:
    ManageInventoryCmdImpl
    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static int ADJUST_INVENTORY
      The action is to adjust inventory, for ATP, it will call stored procedure adjustInventory for non-ATP, it will call AdjustInventoryCmd
      static java.lang.String COPYRIGHT
      The IBM copyright notice field.
      static int CREATE_INVENTORY
      The action is to create inventory, for ATP, it will call task command CreateReceiptCmd for non-ATP, it will call AdjustInventoryCmd
      static java.lang.String defaultCommandClassName
      The default implementation class is "com.ibm.commerce.inventory.commands.ManageInventoryCmdImpl".
      static java.lang.String NAME
      The name of this interface is "com.ibm.commerce.inventory.commands.ManageInventoryCmd".
      • Fields inherited from interface com.ibm.websphere.command.Command

        serialVersionUID
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method and Description
      java.lang.String getComment1()
      Gets the comment specified on the new receipt.
      java.lang.String getComment2()
      Gets the comment specified regarding the quality of the item received.
      java.lang.String getCost()
      Gets the unit cost of the item.
      java.lang.String getDistArrangId()
      Gets the identifier of the distribution arrangement that has access to this received inventory.
      java.lang.String getFfmcenterId()
      Gets the identifier of the fulfillment center where the inventory was received.
      java.lang.String getItemspcId()
      Gets the identifier of the item specified for receipt.
      java.lang.String getMemberId()
      Gets the identifier of the owner of the received item.
      java.lang.String getPartNumber()
      Gets the part number of the received item.
      java.lang.String getQtyReceived()
      Gets the number of items received.
      java.lang.String getRaDetailId()
      Gets the expected inventory record detail identifier for the expected inventory receipt.
      java.lang.String getRcptAvailId()
      Gets the available receipt identifier.
      java.lang.String getReceiptDate()
      Gets the date the inventory was received.
      java.lang.String getReceiptId()
      Gets the identifier of the new receipt.
      java.lang.String getReceiptType()
      Gets the type of receipt which indicates how this receipt was created.
      java.lang.String getRtnRcptDspId()
      Gets the disposition record identifier of the item returned for receipt.
      java.lang.String getSetCCurr()
      Gets the currency of the cost field.
      java.lang.String getVendorId()
      Gets the identifier of the vendor that supplied the inventory.
      java.lang.String getVersionSpcId()
      Gets the product version identifier of the item returned for receipt.
      void setAction(int action)
      Sets the action of whether to adjust inventory or create inventory
      void setCatEntryId(java.lang.String newCatEntryId)
      Sets the identifier of the item specified for receipt.
      void setComment1(java.lang.String newComment1)
      Sets the comment on the new receipt.
      void setComment2(java.lang.String newComment2)
      Sets the comment regarding the quality of the item received.
      void setCost(java.lang.String newCost)
      Sets the unit cost of the item being received.
      void setDistArrangId(java.lang.String newDistArrangId)
      Sets the identifier of the distribution arrangement that has access to this received inventory.
      void setFfmcenterId(java.lang.String newFfmcenterId)
      Sets the fulfillment center identifier.
      void setFlagCheck(java.lang.String newFlagCheck)
      Sets the flag for when updateInventory whether to check quantity
      void setFlagUpdate(java.lang.String newFlagUpdate)
      Sets the flag for when updateInventory/checkInventory whether to update quantity
      void setInvAdjCodeId(java.lang.String newInvAdjCodeId)
      Sets the identifier for the adjustment type being made.
      void setItemspcId(java.lang.String newItemspcId)
      Sets the identifier of the item specified for receipt.
      void setMemberId(java.lang.String newMemberId)
      Sets the identifier of the owner of the item specified for receipt.
      void setPartNumber(java.lang.String newPartNumber)
      Sets the part number of the items being received.
      void setQtyReceived(java.lang.String newQtyReceived)
      Sets the number of items being received.
      void setRaDetailId(java.lang.String newRaDetailId)
      Sets the identifier of the record detail of the expected inventory.
      void setRcptAvailId(java.lang.String newRcptAvailId)
      Sets the identifier of the available receipt.
      void setReceiptDate(java.lang.String newReceiptDate)
      Sets the date the inventory was received.
      void setReceiptId(java.lang.String newReceiptId)
      Sets identifier of the new receipt.
      void setReceiptType(java.lang.String newReceiptType)
      Sets the type of receipt which indicates how this receipt was created.
      void setRtnRcptDspId(java.lang.String newRtnRcptDspId)
      Sets the disposition record identifier of the returned item.
      void setSetCCurr(java.lang.String newSetCCurr)
      Sets the currency of the cost field.
      void setVendorId(java.lang.String newVendorId)
      Sets the identifier of the vendor that supplied the inventory.
      void setVersionSpcId(java.lang.String newVersionSpcId)
      Sets the product version identifier of the item specified for receipt.
      • Methods inherited from interface com.ibm.commerce.command.CacheableECCommand

        execute
      • Methods inherited from interface com.ibm.websphere.command.CacheableCommand

        executeFromCache, getCaller, getEntryInfo, getId, getSharingPolicy, postExecute, preExecute, setCaller, updateCache
      • Methods inherited from interface com.ibm.websphere.command.TargetableCommand

        getCommandTarget, getCommandTargetName, hasOutputProperties, performExecute, setCommandTarget, setCommandTargetName, setOutputProperties
      • Methods inherited from interface com.ibm.websphere.command.Command

        isReadyToCallExecute, reset
      • Methods inherited from interface com.ibm.websphere.command.CommandCaller

        unionDependencies
    • Field Detail

      • COPYRIGHT

        static final java.lang.String COPYRIGHT
        The IBM copyright notice field.
        See Also:
        Constant Field Values
      • NAME

        static final java.lang.String NAME
        The name of this interface is "com.ibm.commerce.inventory.commands.ManageInventoryCmd".
        See Also:
        Constant Field Values
      • defaultCommandClassName

        static final java.lang.String defaultCommandClassName
        The default implementation class is "com.ibm.commerce.inventory.commands.ManageInventoryCmdImpl".
        See Also:
        Constant Field Values
      • ADJUST_INVENTORY

        static final int ADJUST_INVENTORY
        The action is to adjust inventory, for ATP, it will call stored procedure adjustInventory for non-ATP, it will call AdjustInventoryCmd
        See Also:
        Constant Field Values
      • CREATE_INVENTORY

        static final int CREATE_INVENTORY
        The action is to create inventory, for ATP, it will call task command CreateReceiptCmd for non-ATP, it will call AdjustInventoryCmd
        See Also:
        Constant Field Values
    • Method Detail

      • getComment1

        java.lang.String getComment1()
        Gets the comment specified on the new receipt.
        Returns:
        Comment specified on the new receipt.
        See Also:
        setComment1(java.lang.String)
      • getComment2

        java.lang.String getComment2()
        Gets the comment specified regarding the quality of the item received.
        Returns:
        Quality comment on the received item.
        See Also:
        setComment2(java.lang.String)
      • getCost

        java.lang.String getCost()
        Gets the unit cost of the item.
        Returns:
        Cost of the item.
        See Also:
        setCost(java.lang.String)
      • getDistArrangId

        java.lang.String getDistArrangId()
        Gets the identifier of the distribution arrangement that has access to this received inventory.
        Returns:
        Distribution arrangement identifier.
        See Also:
        setDistArrangId(java.lang.String)
      • getFfmcenterId

        java.lang.String getFfmcenterId()
        Gets the identifier of the fulfillment center where the inventory was received.
        Returns:
        Fulfillment center identifier.
        See Also:
        setFfmcenterId(java.lang.String)
      • getItemspcId

        java.lang.String getItemspcId()
        Gets the identifier of the item specified for receipt.
        Returns:
        Item identifier.
        See Also:
        setItemspcId(java.lang.String)
      • getMemberId

        java.lang.String getMemberId()
        Gets the identifier of the owner of the received item.
        Returns:
        Member identifier.
        See Also:
        setMemberId(java.lang.String)
      • getPartNumber

        java.lang.String getPartNumber()
        Gets the part number of the received item. Can be used to uniquely identify an item for the owner identified by memberId.
        Returns:
        Part number.
        See Also:
        setPartNumber(java.lang.String)
      • getRaDetailId

        java.lang.String getRaDetailId()
        Gets the expected inventory record detail identifier for the expected inventory receipt.
        Returns:
        Record detail identifier.
        See Also:
        setRaDetailId(java.lang.String)
      • getRcptAvailId

        java.lang.String getRcptAvailId()
        Gets the available receipt identifier.
        Returns:
        Available receipt identifier.
        See Also:
        setRcptAvailId(java.lang.String)
      • getReceiptDate

        java.lang.String getReceiptDate()
        Gets the date the inventory was received.
        Returns:
        Inventory received date.
        See Also:
        setReceiptDate(java.lang.String)
      • getReceiptId

        java.lang.String getReceiptId()
        Gets the identifier of the new receipt.
        Returns:
        New receipt identifier.
        See Also:
        setReceiptId(java.lang.String)
      • getReceiptType

        java.lang.String getReceiptType()
        Gets the type of receipt which indicates how this receipt was created. (ADHC: Ad hoc receipt, EIR: Expected Inventory Receipt, RTN: returned receipt.)
        Returns:
        Receipt type.
        See Also:
        setReceiptType(java.lang.String)
      • getRtnRcptDspId

        java.lang.String getRtnRcptDspId()
        Gets the disposition record identifier of the item returned for receipt.
        Returns:
        Disposition record identifier.
        See Also:
        setRtnRcptDspId(java.lang.String)
      • getSetCCurr

        java.lang.String getSetCCurr()
        Gets the currency of the cost field.
        Returns:
        Currency of the cost field.
        See Also:
        setSetCCurr(java.lang.String)
      • getVendorId

        java.lang.String getVendorId()
        Gets the identifier of the vendor that supplied the inventory.
        Returns:
        Vendor identifier.
        See Also:
        setVendorId(java.lang.String)
      • getVersionSpcId

        java.lang.String getVersionSpcId()
        Gets the product version identifier of the item returned for receipt.
        Returns:
        Product version identifier.
        See Also:
        setVersionSpcId(java.lang.String)
      • setComment1

        void setComment1(java.lang.String newComment1)
        Sets the comment on the new receipt.
        Parameters:
        newComment1 - generic comment, COMMENT1 property
        See Also:
        getComment1()
      • setComment2

        void setComment2(java.lang.String newComment2)
        Sets the comment regarding the quality of the item received.
        Parameters:
        newComment2 - quality comment, COMMENT2 property
        See Also:
        getComment2()
      • setCost

        void setCost(java.lang.String newCost)
        Sets the unit cost of the item being received.
        Parameters:
        newCost - cost of item, COST property
        See Also:
        getCost()
      • setDistArrangId

        void setDistArrangId(java.lang.String newDistArrangId)
        Sets the identifier of the distribution arrangement that has access to this received inventory.
        Parameters:
        newDistArrangId - distribution arrangement identifier, DISTARRANG_ID property
        See Also:
        getDistArrangId()
      • setFfmcenterId

        void setFfmcenterId(java.lang.String newFfmcenterId)
        Sets the fulfillment center identifier.
        Parameters:
        newFfmcenterId - fulfillment center identifier, FFMCENTER_ID property
        See Also:
        getFfmcenterId()
      • setItemspcId

        void setItemspcId(java.lang.String newItemspcId)
        Sets the identifier of the item specified for receipt.
        Parameters:
        newItemspcId - item specified identifier, ITEMSPC_ID property
        See Also:
        getItemspcId()
      • setCatEntryId

        void setCatEntryId(java.lang.String newCatEntryId)
        Sets the identifier of the item specified for receipt.
        Parameters:
        newCatEntryId - item specified identifier, ITEMSPC_ID property
        See Also:
        getItemspcId()
      • setFlagCheck

        void setFlagCheck(java.lang.String newFlagCheck)
        Sets the flag for when updateInventory whether to check quantity
        Parameters:
        newFlagCheck -
      • setFlagUpdate

        void setFlagUpdate(java.lang.String newFlagUpdate)
        Sets the flag for when updateInventory/checkInventory whether to update quantity
        Parameters:
        newFlagUpdate -
      • setMemberId

        void setMemberId(java.lang.String newMemberId)
        Sets the identifier of the owner of the item specified for receipt.
        Parameters:
        newMemberId - member identifier, MEMBER_ID property
        See Also:
        getMemberId()
      • setPartNumber

        void setPartNumber(java.lang.String newPartNumber)
        Sets the part number of the items being received.
        Parameters:
        newPartNumber - part number, PARTNUMBER property
        See Also:
        getPartNumber()
      • setQtyReceived

        void setQtyReceived(java.lang.String newQtyReceived)
        Sets the number of items being received.
        Parameters:
        newQtyReceived - quantity of received items, QTYRECEIVED property
        See Also:
        getQtyReceived()
      • setRaDetailId

        void setRaDetailId(java.lang.String newRaDetailId)
        Sets the identifier of the record detail of the expected inventory.
        Parameters:
        newRaDetailId - record detail identifier, RADETAIL_ID property
        See Also:
        getRaDetailId()
      • setRcptAvailId

        void setRcptAvailId(java.lang.String newRcptAvailId)
        Sets the identifier of the available receipt.
        Parameters:
        newRcptAvailId - available receipt identifier
        See Also:
        getRcptAvailId()
      • setReceiptDate

        void setReceiptDate(java.lang.String newReceiptDate)
        Sets the date the inventory was received.
        Parameters:
        newReceiptDate - receipt date, RECEIPTDATE property
        See Also:
        getReceiptDate()
      • setReceiptId

        void setReceiptId(java.lang.String newReceiptId)
        Sets identifier of the new receipt. Called by the implementation.
        Parameters:
        newReceiptId - new receipt identifier.
        See Also:
        getReceiptId()
      • setReceiptType

        void setReceiptType(java.lang.String newReceiptType)
        Sets the type of receipt which indicates how this receipt was created.
        Parameters:
        newReceiptType - new receipt type, RECEIPTTYPE property
        See Also:
        getReceiptType()
      • setRtnRcptDspId

        void setRtnRcptDspId(java.lang.String newRtnRcptDspId)
        Sets the disposition record identifier of the returned item.
        Parameters:
        newRtnRcptDspId - disposition record identifier, RTNRCPTDSP_ID property
        See Also:
        getRtnRcptDspId()
      • setSetCCurr

        void setSetCCurr(java.lang.String newSetCCurr)
        Sets the currency of the cost field.
        Parameters:
        newSetCCurr - currency, SETCCURR property
        See Also:
        getSetCCurr()
      • setVendorId

        void setVendorId(java.lang.String newVendorId)
        Sets the identifier of the vendor that supplied the inventory.
        Parameters:
        newVendorId - vendor identifier, VENDOR_ID property
        See Also:
        getVendorId()
      • setVersionSpcId

        void setVersionSpcId(java.lang.String newVersionSpcId)
        Sets the product version identifier of the item specified for receipt.
        Parameters:
        newVersionSpcId - version identifier, VERSIONSPC_ID property
        See Also:
        getVersionSpcId()
      • setInvAdjCodeId

        void setInvAdjCodeId(java.lang.String newInvAdjCodeId)
        Sets the identifier for the adjustment type being made.
        Parameters:
        newInvAdjCodeId - adjustment type id
      • setAction

        void setAction(int action)
        Sets the action of whether to adjust inventory or create inventory
        Parameters:
        action - adjustment type id