com.ibm.commerce.fulfillment.commands
Interface CheckInventoryAvailabilityCmd

All Superinterfaces:
TaskCommand
All Known Implementing Classes:
CheckInventoryAvailabilityBECmdImpl, CheckInventoryAvailabilityCmdImpl

public interface CheckInventoryAvailabilityCmd
extends TaskCommand

Checks that either there is sufficient existing inventory for a list of order items, or that they could be backordered. This task command determines whether a Store can accept items for specified quantities of CatalogEntries, given a prioritized list of fulfillment centers for each one. If the answer is no, an ECApplicationException is thrown, with the message key _API_BAD_INV and the error view CheckInventoryErrorView. Upon successful completion, the estimated availability time and shipping offset attributes of the order item are set. There are two ways to indicate the items to be checked:

  1. If you have OrderItemAccessBean objects, call the setOrderItems and setOrderItemFulfillmentCentersMaps methods to set the list of order items and their associated eligible fulfillment centers.
  2. If you have a catalog entry identifier, call the setCatEntry, and setCatentryFulfillmentCenters methods. Optionally call the setUnitOfMeasure method.

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
 void setCatEntry( Item aCatEntry)
          Sets the item to be checked.
 void setCatEntryFulfillmentCenters(java.util.Vector avCatEntryFulfillmentCenters)
          Sets the list of fulfillment center identifiers for the Item specified by the setCatEntry method.
 void setOrderItemFulfillmentCentersMaps(java.util.Hashtable ahsOrderItemFulfillmentCentersMaps)
          Sets lists of fulfillment centers to check inventory for items specified by the setOrderItems method.
 void setOrderItems(java.util.Enumeration aenOrderItems)
          Sets the items to be checked.
 void setStoreId(java.lang.Integer aStoreId)
          Deprecated. This method has no effect.
 void setUnitOfMeasure(java.lang.String astrUnitOfMeasure)           Sets the unit of measure for the quantity of the Item specified by the setCatEntry method.
 

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

setOrderItems

public void setOrderItems(java.util.Enumeration aenOrderItems)
Sets the items to be checked.
Parameters:
aenOrderItems - the items to be checked (Enumeration of OrderItemAccessBean).

setOrderItemFulfillmentCentersMaps

public void setOrderItemFulfillmentCentersMaps(java.util.Hashtable ahsOrderItemFulfillmentCentersMaps)
Sets lists of fulfillment centers to check inventory for items specified by the setOrderItems method.
Parameters:
ahsOrderItemFulfillmentCentersMaps - lists of fulfillment centers keyed by the order item id. Hashtable:

setStoreId

public void setStoreId(java.lang.Integer aStoreId)
Deprecated. This method has no effect.
Sets the identifier of the store to be checked.
Parameters:
aStoreId - the Store identifier.

setCatEntry

public void setCatEntry(Item aCatEntry)
Sets the item to be checked. If the store identifier of the Item is null, the store identifier from the command context is used.
Parameters:
aCatEntry - the store identifier, catalog entry identifier, and quantity of the Item are used.

setCatEntryFulfillmentCenters

public void setCatEntryFulfillmentCenters(java.util.Vector avCatEntryFulfillmentCenters)
Sets the list of fulfillment center identifiers for the Item specified by the setCatEntry method.
Parameters:
avCatEntryFulfillmentCenters - the list of fulfillment center identifiers (Vector of Integer).

setUnitOfMeasure

public void setUnitOfMeasure(java.lang.String astrUnitOfMeasure)
Sets the unit of measure for the quantity of the Item specified by the setCatEntry method. This method is optional. If it is not called, then the quantity of the Item is multiplied by the nominal quantity and unit of measure specified in the CATENTSHIP record for the CatalogEntry.
Parameters:
astrUnitOfMeasure - unit of measure.