com.ibm.commerce.inventory.commands

Interface ReceiptCreateCmd

  • All Superinterfaces:
    AccCommand, com.ibm.websphere.command.CacheableCommand, com.ibm.websphere.command.Command, com.ibm.websphere.command.CommandCaller, ControllerCommand, ECCommand, Protectable, java.io.Serializable, com.ibm.websphere.command.TargetableCommand, ToolsControllerCommand
    All Known Implementing Classes:
    ReceiptCreateCmdImpl


    public interface ReceiptCreateCmd
    extends ToolsControllerCommand
    Creates an expected inventory receipt or ad hoc receipt. If the expected inventory record detail identifier is provided, an expected inventory receipt will be created. Otherwise, an ad hoc receipt will be created.

    This controller command will call CreateReceiptCmd to create the receipt and insert a new row in itemffmctr table for this item, store and fulfillment center. This is done if row does not yet exist when a receipt is created. This row will be used to record information about reserved quantities, amount on backorder. It is also used to record amount allocated to backorders for this item owned by this store at this fulfillment center.

    This command requires to have the store id set in the command context.

    Parameters

    EC_XMLObject
    An input xml_string that contains all required data for creating new expected inventory receipt.

    Example xml_string for expected inventory receipt:

    
     <?xml version="1.0" encoding="UTF-8"?>
     <XML>
     <XMLFile>inventory.POReceiveInventoryDialog</XMLFile>
     <comment1>Receipt comment</comment1>
     <comment2>Quality comment</comment2>
     <cost>24.5</cost>
     <ffmcenterId>300</ffmcenterId>
     <qtyReceived>230</qtyReceived>
     <raDetailId>10001</raDetailId>
     <receiptDate>2001-10-23 00:00:00.0</receiptDate>
     <setCCurr>CAD</setCCurr> 
     <vendorId>200</vendorId>
     </XML>
     
     

    Example xml_string for ad hoc receipt:

    
     <?xml version="1.0" encoding="UTF-8"?>
     <XML>
     <XMLFile>inventory.POReceiveInventoryDialog</XMLFile>
     <comment1>Receipt comment</comment1>
     <comment2>Quality comment</comment2>
     <cost>24.5</cost>
     <setCCurr>CAD</setCCurr>
     <ffmcenterId>300</ffmcenterId>
     <itemspcId>400</itemspcId>
     <qtyReceived>230</qtyReceived>
     <receiptDate>2001-10-23 00:00:00.0</receiptDate>
     <setCCurr>CAD</setCCurr>
     <vendorId>200</vendorId>
     </XML>
    
     
    URL
    The URL to be called when the command completes successfully.

    Response Parameters

    receiptId
    Return the identifier of the new receipt.
    receiptType
    Return the type of the receipt which indicates how this receipt was created. (ADHC: Ad hoc receipt, EIR: Expected Inventory Receipt)

    Exceptions

    When the required fields are missing or not in the right data type, this command will throw exception to indicate which field is missing or bad.

    • Field Detail

      • COPYRIGHT

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

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

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

      • setComment1

        void setComment1(java.lang.String newComment1)
        Sets comment1 (receipt comment).
        Parameters:
        newComment1 - comment
      • setComment2

        void setComment2(java.lang.String newComment2)
        Sets comment2 (quality comment).
        Parameters:
        newComment2 - comment
      • setCost

        void setCost(java.lang.String newCost)
        Sets unit cost.
        Parameters:
        newCost - unit cost
      • setDistArrangId

        void setDistArrangId(java.lang.String newDistArrangId)
        Sets distribution arrangement identifier.
        Parameters:
        newDistArrangId - distribution arrangement identifier
      • setFfmcenterId

        void setFfmcenterId(java.lang.String newFfmcenterId)
        Sets fulfillment center identifier.
        Parameters:
        newFfmcenterId - fulfillment center identifier
      • setItemspcId

        void setItemspcId(java.lang.String newItemspcId)
        Sets item identifier.
        Parameters:
        newItemspcId - item identifier
      • setMemberId

        void setMemberId(java.lang.String newMemberId)
        Sets member identifier.
        Parameters:
        newMemberId - owner identifier
      • setPartNumber

        void setPartNumber(java.lang.String newPartNumber)
        Sets the part number.
        Parameters:
        newPartNumber - part number
      • setQtyReceived

        void setQtyReceived(java.lang.String newQtyReceived)
        Sets the quantity received.
        Parameters:
        newQtyReceived - quantity received
      • setRaDetailId

        void setRaDetailId(java.lang.String newRaDetailId)
        Sets expected inventory record detail identifier.
        Parameters:
        newRaDetailId - record detail identifier
      • setRcptAvailId

        void setRcptAvailId(java.lang.String newRcptAvailId)
        Sets available receipt identifier.
        Parameters:
        newRcptAvailId - available receipt identifier
      • setReceiptDate

        void setReceiptDate(java.lang.String newReceiptDate)
        Sets the date the inventory was received.
        Parameters:
        newReceiptDate - date inventory was received
      • setReceiptId

        void setReceiptId(java.lang.String newReceiptId)
        Sets the receipt identifier.
        Parameters:
        newReceiptId - receipt identifier
      • setReceiptType

        void setReceiptType(java.lang.String newReceiptType)
        Sets type of receipt which indicates how this receipt was created.
        Parameters:
        newReceiptType - receipt type
      • setRtnRcptDspId

        void setRtnRcptDspId(java.lang.String newRtnRcptDspId)
        Sets the disposition record identifier of returned item.
        Parameters:
        newRtnRcptDspId - return receipt disposition identifier
      • setSetCCurr

        void setSetCCurr(java.lang.String newSetCCurr)
        Sets currency of the COST field.
        Parameters:
        newSetCCurr - currency
      • setVendorId

        void setVendorId(java.lang.String newVendorId)
        Sets the identifier of the vendor that supplied the inventory.
        Parameters:
        newVendorId - vendor identifier
      • setVersionSpcId

        void setVersionSpcId(java.lang.String newVersionSpcId)
        Sets the product version identifier of the item.
        Parameters:
        newVersionSpcId - version identifier