com.ibm.commerce.inventory.commands

Interface ReserveInventoryCmd

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:

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:

• requested quantity
• itemspec id
• fulfillment center id
• store id
• reservation type
• description (reservation instance)

Field Summary

Fields

Modifier and Type	Field and Description
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".

Fields inherited from interface com.ibm.websphere.command.Command

serialVersionUID

Method Summary

Modifier and Type	Method and Description
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.

Methods inherited from interface com.ibm.commerce.command.CacheableECCommand

execute

Methods inherited from interface com.ibm.websphere.command.CacheableCommand

executeFromCache, getCaller, getEntryInfo, getId, getSharingPolicy, postExecute, preExecute, setCaller, updateCache

Methods inherited from interface com.ibm.websphere.command.TargetableCommand

getCommandTarget, getCommandTargetName, hasOutputProperties, performExecute, setCommandTarget, setCommandTargetName, setOutputProperties

Methods inherited from interface com.ibm.websphere.command.Command

isReadyToCallExecute, reset

Methods inherited from interface com.ibm.websphere.command.CommandCaller

unionDependencies

Methods inherited from interface com.ibm.commerce.command.ECCommand

checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getPostInvokeParameters, getPreInvokeParameters, getResources, getStoreId, getUser, getUserId, performExecute, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters

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.ReserveInventoryCmd".

See Also:

Constant Field Values

defaultCommandClassName

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

java.lang.Long getReserveId()

Gets the reservation identifier created after executing this command.

Returns:

The new Reservation id.

setFFCId

void setFFCId(java.lang.Integer argFFCId)

Sets the fulfillment center identifier.

Parameters:

argFFCId - fulfillment center id

setItemSpcId

void setItemSpcId(java.lang.Long argItemSpcId)

Sets the item specified for reservation.

Parameters:

argItemSpcId - item id

setQuantity

void setQuantity(java.lang.Integer argQuantity)

Sets the quantity of the reservation.

Parameters:

argQuantity - reservation quantity

setReservationInstance

void setReservationInstance(java.lang.String argReservationInstance)

Sets the reservation description identifying the instance.

Parameters:

argReservationInstance - reservation description

setReservationType

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