com.ibm.commerce.inventory.commands

Interface AdjustReceiptCmd

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

    public interface AdjustReceiptCmd
extends TaskCommand
    Makes an adjustment to existing inventory by calling the adjustinventory database stored procedure.

    An adjustment can be made by marking down quantities in one or more RECEIPT rows (when the adjustment is negative). Adjustment can also be made by adding inventory to an existing RECEIPT row (when the adjustment is positive).

    This controller command requires that the store id is set in the command context.

    Parameters

    EC_XMLObject
    An input xml_string that contains all required data for adjusting an inventory.

    Example xml_string for adjusting an inventory: 

    
 <?xml version="1.0" encoding="UTF-8"?>
 <XML>
 <XMLFile>inventory.InventoryAdjustmentDialog</XMLFile>
 <adjustmentComment>Adjustment comment</adjustmentComment>
 <ffmcenterId>300</ffmcenterId>
 <invAdjCodeId>600</invAdjCodeId>
 <itemspcId>400</itemspcId>
 <quantity>250</quantity> 
 <versionSpcId>400</versionSpcId>
 </XML>
    URL
    The URL to be called when the command completes successfully.

    Exceptions

    When the required fields are missing or not in the right data type, this command will throw an exception. It indicates 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.InventoryAdjustCmd".
        See Also:
        Constant Field Values

      • defaultCommandClassName

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

    • Method Detail

      • setAdjustmentComment

        void setAdjustmentComment(java.lang.String newAdjustmentComment)
        Sets the comment on the adjustment.
        Parameters:
        newAdjustmentComment - comment

      • setFfmcenterId

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

      • setInvAdjCodeId

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

      • setItemspcId

        void setItemspcId(java.lang.String newItemspcId)
        Sets the item identifier.
        Parameters:
        newItemspcId - item specified id

      • setMemberId

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

      • setPartNumber

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

      • setQuantity

        void setQuantity(java.lang.String newQuantity)
        Sets the quantity to adjust.
        Parameters:
        newQuantity - adjustment quantity

      • setVersionSpcId

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