com.ibm.commerce.inventory.commands
Interface AdjustInventoryReservationCmd

All Superinterfaces:
TaskCommand
All Known Implementing Classes:
AdjustInventoryReservationCmdImpl

public interface AdjustInventoryReservationCmd
extends TaskCommand

Adjusts the inventory for a given inventory reservation by the amount of the given quantity. This is a task command. Required arguments are inventory reservation number and adjustment quantity (which may be negative).

If quantity argument is negative it means release inventory. If this is the case, see if there is enough inventory reserved to satisfy the release amount.

If quantity argument is positive it means add inventory to the reservation. If this is the case, see if there is enough inventory to satisfy the additional reservation amount.

Assuming the above edit checks are successful, adjust the quantity reserved by the amount of the quantity argument.


Field Summary
static java.lang.String COPYRIGHT
          The internal copyright field.
static java.lang.String defaultCommandClassName
          The default implementation class is "com.ibm.commerce.inventory.commands.AdjustInventoryReservationCmdImpl".
static java.lang.String NAME
          The name of this interface is "com.ibm.commerce.inventory.commands.AdjustInventoryReservationCmd".
 
Method Summary
 void setInvRsrvId(java.lang.Long argInvRsrvId)
          Identifies the inventory reservation to be adjusted.
 void setQuantity(java.lang.Integer argQuantity)           Sets the adjustment quantity for the inventory reservation negatively or positively.
 

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

defaultCommandClassName

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

setInvRsrvId

public void setInvRsrvId(java.lang.Long argInvRsrvId)
Identifies the inventory reservation to be adjusted.
Parameters:
argInvRsrvId - reservation identifier

setQuantity

public void setQuantity(java.lang.Integer argQuantity)
Sets the adjustment quantity for the inventory reservation negatively or positively.
Parameters:
argQuantity - number of items to adjust in the inventory reservation.