com.ibm.commerce.fulfillment.commands

Interface AllocateInventoryCmd

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

    public interface AllocateInventoryCmd
extends TaskCommand
    Perform ATP inventory operations for a list of order items.

    Optionally performs some of the following operations for each order item:
    1. Merge, if possible, order items in the same correlation group. (Two order items in the same correlation group were split during a previous call to AllocateInventory command. It is possible to merge two order items if they have the same information except for some information. The information includes their quantity and information related to their allocation status, such as estimated shipping date offset.) Before an order item is merged, it is deallocated.
    2. Merge, if possible, specified order items, not necessarily in the same correlation group. Order items can be merged if they have identical values for all columns except for ORDERITEMS_ID, QUANTITY, CORRELATIONGROUP, LASTCREATE, LASTUPDATE. And also except for information calculated by PrepareOrder task command (such as SHIPCHARGE, SHIPTAXAMOUNT, TAXAMOUNT, TOTALADJUSTMENT, and TOTALPRODUCT). And information specific to the allocation status, such as estimated availability time.
    3. Check that specified order items can be allocated, either from existing or expected inventory. And obtain a fulfillment center and an estimated availability time and shipping offset.
    4. Allocate specified order items from existing inventory, and obtain a fulfillment center and an estimated shipping offset for each order item. The process of allocating from existing inventory may result in an order item being split into multiple order items. When that happens, the so split order items have the same information (including correlation group) except for some information. The information includes their quantity and other information related to their allocation status, such as fulfillment center.
    5. Backorder (allocate from expected inventory) specified order items, and obtain a fulfillment center and an estimated availability time and shipping offset for each order item.
    6. Deallocate specified order items if they are allocated to existing or expected inventory.

    • Field Detail

      • COPYRIGHT

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

      • NAME

        static final java.lang.String NAME
        The name of this task command interface.
        See Also:
        Constant Field Values

      • defaultCommandClassName

        static final java.lang.String defaultCommandClassName
        The name of the default implementation of this task command interface.
        See Also:
        Constant Field Values

    • Method Detail

      • setAllocateOrderItems

        void setAllocateOrderItems(java.util.Hashtable ahsAllocateOrderItems)
        Sets the order items to be allocated from existing inventory. Fulfillment centers and estimated shipping date offsets will be set for successfully allocated order items.
        Parameters:
        ahsAllocateOrderItems - the order items to be allocated. Hashtable:
        • key - (Long) The identifier of the order item.
        • value - (OrderItemAccessBean) The order item.

      • setAllOrderItems

        void setAllOrderItems(java.util.Hashtable ahsAllOrderItems)
        Sets all order items to be considered when determining fulfillment centers or merging order items. Normally this is all the order items in an order.
        Parameters:
        ahsAllOrderItems - all the order items to be considered. Hashtable:
        • key - (Long) The identifier of the order item.
        • value - (OrderItemAccessBean) The order item.

      • setBackorderOrderItems

        void setBackorderOrderItems(java.util.Hashtable ahsBackorderOrderItems)
        Sets the order items to be backordered (allocated from expected inventory). If an order item appears in both lists of order items set by setAllocateOrderItems and setBackorderOrderItems. Then it is backordered only if it cannot be allocated from existing inventory. Fulfillment centers and estimated shipping date offsets will be set for successfully backordered order items.
        Parameters:
        ahsBackorderOrderItems - the order items to be backordered. Hashtable:
        • key - (Long) The identifier of the order item.
        • value - (OrderItemAccessBean) The order item.

      • setCheckOrderItems

        void setCheckOrderItems(java.util.Hashtable ahsCheckOrderItems)
        Sets the order items to be checked by the CheckInventoryAvailability task command. Fulfillment centers and estimated shipping date offsets will be set for those order items that successfully pass the check.
        Parameters:
        ahsCheckOrderItems - the order items to be checked. Hashtable:
        • key - (Long) The identifier of the order item.
        • value - (OrderItemAccessBean) The order item.

      • setMergeOrderItems

        void setMergeOrderItems(java.util.Hashtable ashMergeOrderItems)
        Sets the order items to be merged, if possible.
        Parameters:
        ashMergeOrderItems - the order items to be merged. Hashtable:
        • key - (Long) The identifier of the order item.
        • value - (OrderItemAccessBean) The order item.

      • setRemergeOrderItems

        void setRemergeOrderItems(java.util.Hashtable ahsRemergeOrderItems)
        Sets the order items to be merged, if possible, with other order items with the same correlation group.
        Parameters:
        ahsRemergeOrderItems - the order items to be merged. Hashtable:
        • key - (Long) The identifier of the order item.
        • value - (OrderItemAccessBean) The order item.

      • setReverseOrderItems

        void setReverseOrderItems(java.util.Hashtable ahsReverseOrderItems)
        Sets the order items to be deallocated, if they are allocated or backordered.
        Parameters:
        ahsReverseOrderItems - the order items to be deallocated. Hashtable:
        • key - (Long) The identifier of the order item.
        • value - (OrderItemAccessBean) The order item.
Skip navigation links