com.ibm.commerce.inventory.commands
Interface InventoryAdjustCmd

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

public interface InventoryAdjustCmd
extends ToolsControllerCommand

Makes an adjustment to existing inventory by calling the adjustinventory database stored procedure. 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 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 to indicate which field is missing or bad.


Field Summary
static java.lang.String COPYRIGHT
          The internal copyright field.
static java.lang.String defaultCommandClassName
          The default implementation class name is "com.ibm.commerce.inventory.commands.InventoryAdjustCmdImpl".
static java.lang.String NAME
          The name of this interface is "com.ibm.commerce.inventory.commands.InventoryAdjustCmd".
 
Method Summary
 void setAdjustmentComment(java.lang.String newAdjustmentComment)
          Sets the comment on the adjustment.
 void setFfmcenterId(java.lang.String newFfmcenterId)
          Sets the fulfillment center identifier.
 void setInvAdjCodeId(java.lang.String newInvAdjCodeId)
          Sets the identifier for the adjustment type being made.
 void setItemspcId(java.lang.String newItemspcId)
          Sets the item identifier.
 void setMemberId(java.lang.String newMemberId)
          Sets the member identifier.
 void setPartNumber(java.lang.String newPartNumber)
          Sets the part number.
 void setQuantity(java.lang.String newQuantity)
          Sets the quantity to adjust.
 void setVersionSpcId(java.lang.String newVersionSpcId)
          Sets the product version identifier of the item.
 
Methods inherited from interface com.ibm.commerce.command. ControllerCommand
checkPermission, 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, getResourceOwners, setAccCheck, setForUserId, setOwner
 
Methods inherited from interface com.ibm.commerce.command. ECCommand
checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getResources, getStoreId, getUser, getUserId, performExecute, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters
 

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

NAME

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

defaultCommandClassName

public 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

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

setFfmcenterId

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

setInvAdjCodeId

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

setItemspcId

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

setMemberId

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

setPartNumber

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

setQuantity

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

setVersionSpcId

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