com.ibm.commerce.fulfillment.commands
Interface GetEligibleFulfillmentCentersCmd

All Superinterfaces:
TaskCommand
All Known Implementing Classes:
GetEligibleFulfillmentCentersCmdImpl

public interface GetEligibleFulfillmentCentersCmd
extends TaskCommand

For each input item, returns a list of fulfillment centers (ordered in sequence of descending preference from first to last) that could ship that item if there was sufficient inventory.


Field Summary
static java.lang.String COPYRIGHT
          IBM Copyright notice field.
static java.lang.String defaultCommandClassName
          The name of the default implementation class for this command interface.
static java.lang.String NAME
          The name of this command interface.
 
Method Summary
 java.util.Vector getFulfillmentCenters()
          Returns a list of fulfillment centers that could ship an item specified by the setOrderItem method.
 java.util.Hashtable getOrderItemFulfillmentCentersMaps()
          Gets lists of fulfillment centers which can ship items specified by the setOrderItems method.
 void setAllOrderItems(java.util.Vector newAllOrderItems)
          Sets all order items to be considered when determining fulfillment centers.
 void setOrderItem( Item anOrderItemData)
          Sets the item (with specified catalog entry id) for which eligible fulfillment centers are to be determined.
 void setOrderItems(java.util.Vector newOrderItems)
          Sets the item (with specified catalog entry id) for which eligible fulfillment centers are to be determined.
 void setPreferredFulfillmentCenterId(java.lang.Integer newPreferredFulfillmentCenterId)           Sets the preferred fulfillment center.
 

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 command interface.
See Also:
Constant Field Values

defaultCommandClassName

public static final java.lang.String defaultCommandClassName
The name of the default implementation class for this command interface.
See Also:
Constant Field Values
Method Detail

getFulfillmentCenters

public java.util.Vector getFulfillmentCenters()
Returns a list of fulfillment centers that could ship an item specified by the setOrderItem method. This method is used to obtain a list of fulfillment centers for an order item if only one order item has been passed as input if more than one order item data has been passed as input then getOrderItemFulfillmentCentersMaps should be called instead.
Returns:
a Vector of Integer fulfillment center identifiers.

getOrderItemFulfillmentCentersMaps

public java.util.Hashtable getOrderItemFulfillmentCentersMaps()
Gets lists of fulfillment centers which can ship items specified by the setOrderItems method.
Returns:
HashTable:
  • key - (Long) The OrderItem identifier, if known. Otherwise, a negative number.
  • value - (Object[2]) Object[0] is the com.ibm.commerce.order.calculation.Item. Object[1] is a Vector of Integer fulfillment center identifiers.

setAllOrderItems

public void setAllOrderItems(java.util.Vector newAllOrderItems)
Sets all order items to be considered when determining fulfillment centers. Normally this is all the order items in an order. If setAllOrderItems is not called, this command behaves as if it was called with the same OrderItems specified by setOrderItem or setOrderItems.
Parameters:
newAllOrderItems - a Vector of com.ibm.commerce.order.calculation.Item.

setOrderItem

public void setOrderItem(Item anOrderItemData)
Sets the item (with specified catalog entry id) for which eligible fulfillment centers are to be determined. If both setOrderItem and SetOrderItems are called, only the last call has effect.
Parameters:
anOrderItemData - the order item.

setOrderItems

public void setOrderItems(java.util.Vector newOrderItems)
Sets the item (with specified catalog entry id) for which eligible fulfillment centers are to be determined. If both setOrderItem and SetOrderItems are called, only the last call has effect.
Parameters:
newOrderItems - a Vector of Item.

setPreferredFulfillmentCenterId

public void setPreferredFulfillmentCenterId(java.lang.Integer newPreferredFulfillmentCenterId)
Sets the preferred fulfillment center.
Parameters:
newPreferredFulfillmentCenterId - the identifier of the preferred fulfillment center.