com.ibm.commerce.inventory.commands
Interface InventoryAdjustCmd

All Superinterfaces:
AccCommand, ControllerCommand, ECCommand, Protectable, ToolsControllerCommand
All Known Implementing Classes:
InventoryAdjustCmdImpl

public interface InventoryAdjustCmd
extends ToolsControllerCommand

Make an adjustment to existing inventory by calling the stored procedure AdjustInventory. An adjustment can be made by either marking down quantities in one or more RECEIPT rows (when the adjustment is negative), or adding inventory to an existing RECEIPT row (when the adjustment is positive).

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 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 exception to indicate which field is missing or bad.


Field Summary
static java.lang.String COPYRIGHT
           
static java.lang.String defaultCommandClassName
          The default implementation class name.
static java.lang.String NAME
           
 
Method Summary
 void setAdjustmentComment(java.lang.String newAdjustmentComment)
          Set the comment on the adjustment.
 void setFfmcenterId(java.lang.String newFfmcenterId)
          Set the fulfillment center identifier.
 void setInvAdjCodeId(java.lang.String newInvAdjCodeId)
          Set the identifier for the adjustment type being made.
 void setItemspcId(java.lang.String newItemspcId)
          Set the item identifier.
 void setMemberId(java.lang.String newMemberId)
          Set the member identifier.
 void setPartNumber(java.lang.String newPartNumber)
          Set the part number.
 void setQuantity(java.lang.String newQuantity)
          Set the quantity to adjust.
 void setVersionSpcId(java.lang.String newVersionSpcId)
          Set the product version identifier of the item.
 
Methods inherited from interface com.ibm.commerce.command.ControllerCommand
execute, getGeneric, getRequestProperties, getResolvedRequestProperties, getResponseProperties, getRetriable, getViewInputProperties, isGeneric, isRetriable, mergeProperties, setGeneric, setRequestProperties, setRetriable, setViewInputProperties
 
Methods inherited from interface com.ibm.commerce.command.AccCommand
accessControlCheck, getAccCheck, getForUserId, setAccCheck, setForUserId, setOwner
 
Methods inherited from interface com.ibm.commerce.command.ECCommand
checkIsAllowed, checkResourcePermission, getCommandContext, getCommandIfName, getCommandName, getDefaultProperties, getResources, getStoreId, getUser, getUserId, performExecute, setCommandContext, setCommandIfName, setDefaultProperties, validateParameters
 
Methods inherited from interface com.ibm.commerce.security.Protectable
fulfills, getOwner
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

defaultCommandClassName

public static final java.lang.String defaultCommandClassName
The default implementation class name.

NAME

public static final java.lang.String NAME
Method Detail

setAdjustmentComment

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

setFfmcenterId

public void setFfmcenterId(java.lang.String newFfmcenterId)
Set the fulfillment center identifier.
Parameters:
newFfmcenterId - java.lang.Long

setInvAdjCodeId

public void setInvAdjCodeId(java.lang.String newInvAdjCodeId)
Set the identifier for the adjustment type being made.
Parameters:
newInvAdjCodeId - java.lang.Long

setItemspcId

public void setItemspcId(java.lang.String newItemspcId)
Set the item identifier.
Parameters:
newItemspcId - java.lang.Long

setMemberId

public void setMemberId(java.lang.String newMemberId)
Set the member identifier.
Parameters:
newMemberId - java.lang.String

setPartNumber

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

setQuantity

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

setVersionSpcId

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