com.ibm.commerce.fulfillment.commands

Interface AllocateExistingInventoryCmd

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:

AllocateExistingInventoryCmdImpl

public interface AllocateExistingInventoryCmd
extends TaskCommand

Allocates existing inventory for a particular order item at a particular fulfillment center.

The AllocateExistingInventory task command is called by the default implementation of the AllocateInventory task command. It allocates existing ATP inventory for a specified order item. The order item is from one of the fulfillment centers specified in a prioritized list of fulfillment centers.

All, some, or none of the needed quantity may be allocated by this task command. If all or some is allocated, the inventoryStatus attribute of the OrderItem is set to 'ALLC'. And allocatedQuantity attribute of the OrderItem is set to the quantity allocated. Otherwise, the OrderItem is not changed.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT IBM copyright notice field.
static java.lang.String	defaultCommandClassName The name of the default implementation of this task command interface.
static java.lang.String	NAME The name of this task command interface.

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

serialVersionUID

Method Summary

Modifier and Type	Method and Description
java.lang.Integer	getNextStrategy() Gets the next allocation strategy set by the command.
void	setFulfillmentCenters(java.util.Vector newFulfillmentCenters) Sets a prioritized list of fulfillment centers from which the inventory should be allocated.
void	setOrderItem(OrderItemAccessBean anOrderItem) Sets the order item for which existing inventory is to be allocated.
void	setStrategy(java.lang.Integer newStrategy) Sets the allocation strategy to be used.

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

IBM copyright notice field.

See Also:

Constant Field Values

NAME

static final java.lang.String NAME

The name of this task command interface.

See Also:

Constant Field Values

defaultCommandClassName

static final java.lang.String defaultCommandClassName

The name of the default implementation of this task command interface.

See Also:

Constant Field Values

Method Detail

getNextStrategy

java.lang.Integer getNextStrategy()

Gets the next allocation strategy set by the command. A changed strategy indicates to the caller that if the allocation performed by this task command is unacceptable to the caller. The caller can call this task command again (after reversing the unacceptable allocation) to perhaps achieve a more acceptable allocation.

Returns:

the next strategy.

setFulfillmentCenters

void setFulfillmentCenters(java.util.Vector newFulfillmentCenters)

Sets a prioritized list of fulfillment centers from which the inventory should be allocated.

Parameters:

newFulfillmentCenters - a prioritized list of fulfillment center identifiers (Vector of Integer).

setOrderItem

void setOrderItem(OrderItemAccessBean anOrderItem)

Sets the order item for which existing inventory is to be allocated.

Parameters:

anOrderItem - the order item.

setStrategy

void setStrategy(java.lang.Integer newStrategy)

Sets the allocation strategy to be used. Zero must be an acceptable value. The caller can specify zero, or a value returned by the getStrategy method after a previous execution of this task command.

Parameters:

newStrategy - the strategy to be used.