com.ibm.commerce.fulfillment.commands

Interface CheckInventoryAvailabilityCmd

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:

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 methods setOrderItems(java.util.Enumeration) and setOrderItemFulfillmentCentersMaps(java.util.Hashtable) to set the list of order items and their associated eligible fulfillment centers.
2. If you have a catalog entry identifier, call the methods setCatEntry(com.ibm.commerce.order.calculation.Item), and setCatEntryFulfillmentCenters(java.util.Vector). Optionally call the method setUnitOfMeasure(java.lang.String).

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

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

setOrderItems

void setOrderItems(java.util.Enumeration aenOrderItems)

Sets the items to be checked.

Parameters:

aenOrderItems - the items to be checked (Enumeration of OrderItemAccessBean).

setOrderItemFulfillmentCentersMaps

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:

• key - (Long) The identifier of the order item.
• value - (OrderItemAccessBean) The order item.

setStoreId

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

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

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

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 get from the following way: multiplied by the nominal quantity and unit of measure specified in the CATENTSHIP record for the CatalogEntry.

Parameters:

astrUnitOfMeasure - unit of measure.