com.ibm.commerce.orderitems.commands

Interface AddItemsToFulfillmentOrderCmd

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


    public interface AddItemsToFulfillmentOrderCmd
    extends TaskCommand
    This AddItemsToFulfillmentOrderCmd Task Command is called by the AssignToSpecifiedFulfillmentCenterCmd Controller Command to add items to a fulfillment order at the specified fulfillment center store.

    The command could be used to add items to an existing fulfillment order if a fulfillment order ID is specified. If no fulfillment order ID is specified, a new fulfillment order is created.

    • 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 the Command Interface class.
      • defaultCommandClassName

        static final java.lang.String defaultCommandClassName
        The default implementation class.
        See Also:
        Constant Field Values
    • Method Detail

      • getOrderReferenceNumber

        java.lang.String getOrderReferenceNumber()
        Returns the order reference number of the fulfillment order.
        Returns:
        The order reference number.
      • setCatalogEntryId

        void setCatalogEntryId(java.util.Hashtable ahshCatEntryId)
        Sets the Catalog Entry ID parameters.

        Specifies the IDs of the catalog entries to be added to the fulfillment order.

        This is a mandatory parameter.

        Parameters:
        ahshCatEntryId - The Hashtable containing the string representation of the IDs of the Catalog Entries that are to be added to the fulfillment order. Each Catalog Entry ID is keyed by an Integer index starting with the Integer with int value of 1.
      • setFulfillmentOrderId

        void setFulfillmentOrderId(java.lang.String strOrderId)
        Sets the fulfillmentOrderId property of the command.

        This parameter is required if we are adding to an existing fulfillment order.

        Parameters:
        strOrderId - The ID of the fulfillment order that is to be the target for this add operation.
      • setFulfillmentOrderName

        void setFulfillmentOrderName(java.lang.String strOrderName)
        Sets the fulfillmentOrderName property of the command.

        This parameter is ignored if we are adding to an existing order.

        Parameters:
        strOrderName - The name to be used for the fulfillment order if a new one is to be created by this add operation.
      • setItemSpecId

        void setItemSpecId(java.util.Hashtable ahshItemSpecId)
        Sets the specified item ID parameters.

        Specifies the IDs of the specified items that are to be added to the fulfillment order.

        A command implementation may use either the ItemSpec IDs or the CatalogEntry IDs to identify the items to be added to the fulfillment order.

        Parameters:
        ahshItemSpecId - The Hashtable containing the string representation of the IDs of the specified items that are to be added to the fulfillment order. Each ItemSpec ID is keyed by an Integer index starting with the Integer with int value of 1.
      • setItemSpecQuantity

        void setItemSpecQuantity(java.util.Hashtable ahshQuantity)
        Sets the specified item quantity parameters.

        Specifies the quantities of the specified items we want to add to the fulfillment order.

        Parameters:
        ahshQuantity - The Hashtable containing the string representation of the quantities of specified items that are to be added to the fulfillment order. Each quantity value is keyed by an Integer index starting with the Integer with int value of 1.
      • setQuantity

        void setQuantity(java.util.Hashtable ahshQuantity)
        Sets the quantity parameters.

        Specifies the quantities of the Catalog Entry items we want to add to the fulfillment order.

        Parameters:
        ahshQuantity - The Hashtable containing the string representation of the quantities of items that are to be added to the fulfillment order. Each quantity value is keyed by an Integer index starting with the Integer with int value of 1.