com.ibm.commerce.inventory.commands

Interface ExpectedInventoryRecordCreateCmd

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


    public interface ExpectedInventoryRecordCreateCmd
    extends ToolsControllerCommand
    Creates an expected inventory record.

    This controller 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 record.

    Example xml_string:

    
     <?xml version="1.0" encoding="UTF-8"?>
     <XML>
     <XMLFile>inventory.VendorWizard</XMLFile>
     <externalId>External id 1234</externalId>
     <orderDate>2001-10-03 00:00:00.0</orderDate>
     <vendorId>200</vendorId>
     <addedSize>2</addedSize>
     <addedRaItem>
           <expectedDate>2001-10-25 00:00:00.0</expectedDate>
           <ffmcenterId>300</ffmcenterId>
           <itemspcId>400</itemspcId>
           <qtyOrdered>230</qtyOrdered>
           <raDetailComment>Comment for item 1</raDetailComment>
     </addedRaItem>
     <addedRaItem>
        <expectedDate>2001-10-25 00:00:00.0</expectedDate>
              <ffmcenterId>300</ffmcenterId>
        <itemspcId>410</itemspcId>
        <qtyOrdered>250</qtyOrdered>
              <raDetailComment>Comment for item 2</raDetailComment>
        </addedRaItem>
     </XML>
    
     
    URL
    The URL to be called when the command completes successfully.

    Response Parameters

    raId
    Return the identifier of the new expected inventory record.

    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.ExpectedInventoryRecordCreateCmd".
        See Also:
        Constant Field Values
      • defaultCommandClassName

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

      • setAddedItem

        void setAddedItem(java.util.Vector newAddedItem)
        Sets the list of items included in the new expected inventory record.
        Parameters:
        newAddedItem - list of inventory items
      • setAddedSize

        void setAddedSize(java.lang.String newAddedSize)
        Sets the number of items included in the new expected inventory record.
        Parameters:
        newAddedSize - quantity
      • setExternalId

        void setExternalId(java.lang.String newExternalId)
        Sets the external identifier.
        Parameters:
        newExternalId - external id
      • setOrderDate

        void setOrderDate(java.lang.String newOrderDate)
        Sets the date this order is created with the vendor.
        Parameters:
        newOrderDate - order create date
      • setVendorId

        void setVendorId(java.lang.String newVendorId)
        Sets the vendor identifier.
        Parameters:
        newVendorId - vendor id