com.ibm.commerce.inventory.commands
Interface ReserveInventoryCmd

All Superinterfaces:
TaskCommand
All Known Implementing Classes:
ReserveInventoryCmdImpl

public interface ReserveInventoryCmd
extends TaskCommand

Creates a reservation of a requested quantity of inventory of a given item from a given fulfillment center for a given store. Following a successful reservation, the reservation number may be obtained by calling the getReserveId() method.

Adds a row to the INVRESERVE table.

Required parameters are:


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.ReserveInventoryCmdImpl".
static java.lang.String NAME
          The name of this interface is "com.ibm.commerce.inventory.commands.ReserveInventoryCmd".
 
Method Summary
 java.lang.Long getReserveId()
          Gets the reservation identifier created after executing this command.
 void setFFCId(java.lang.Integer argFFCId)
          Sets the fulfillment center identifier.
 void setItemSpcId(java.lang.Long argItemSpcId)
          Sets the item specified for reservation.
 void setQuantity(java.lang.Integer argQuantity)
          Sets the quantity of the reservation.
 void setReservationInstance(java.lang.String argReservationInstance)
          Sets the reservation description identifying the instance.
 void setReservationType(java.lang.Long argReservationType)           Sets the reservation type.
 

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

defaultCommandClassName

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

getReserveId

public java.lang.Long getReserveId()
Gets the reservation identifier created after executing this command.
Returns:
The new Reservation id.

setFFCId

public void setFFCId(java.lang.Integer argFFCId)
Sets the fulfillment center identifier.
Parameters:
argFFCId - fulfillment center id

setItemSpcId

public void setItemSpcId(java.lang.Long argItemSpcId)
Sets the item specified for reservation.
Parameters:
argItemSpcId - item id

setQuantity

public void setQuantity(java.lang.Integer argQuantity)
Sets the quantity of the reservation.
Parameters:
argQuantity - reservation quantity

setReservationInstance

public void setReservationInstance(java.lang.String argReservationInstance)
Sets the reservation description identifying the instance.
Parameters:
argReservationInstance - reservation description

setReservationType

public void setReservationType(java.lang.Long argReservationType)
Sets the reservation type. The type or purpose of the reservation, such as an auction. The types are user defined and are in the INVRSRVTYP table.
Parameters:
argReservationType - reservation type