com.ibm.commerce.fulfillment.commands
Interface AllocateExistingInventoryCmd

All Superinterfaces:
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 to allocate existing ATP inventory for a specified order item 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
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.
 
Method Summary
 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.
 

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

NAME

public static final java.lang.String NAME
The name of this task command interface.
See Also:
Constant Field Values

defaultCommandClassName

public 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

public 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 stategy.

setFulfillmentCenters

public 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

public void setOrderItem(OrderItemAccessBean anOrderItem)
Sets the order item for which existing inventory is to be allocated.
Parameters:
anOrderItem - the order item.

setStrategy

public 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.