com.ibm.commerce.fulfillment.commands
Interface CheckInventoryCmd
-
- 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:
- CheckInventoryCmdImpl, InventoryBaseCmdImpl, ResolveFulfillmentCenterCmdImpl, ReverseUpdateInventoryCmdImpl, UpdateInventoryCmdImpl, UpdateInventoryForOrderItemsCmdImpl
public interface CheckInventoryCmd extends TaskCommand
CheckInventory let you check inventory for items. There are two ways to check inventory.- Set one or list of order items by calling setOrderItem method.
- Set one catalog entry by calling setCatEntryId, setQuantity and setStoreId methods. Method setQuantityMeasure is optional.
If the check inventory fails, it throws ECApplicationException with the message key _API_BAD_INV and the error view of CheckInventoryErrorView.
-
-
Field Summary
Fields Modifier and Type Field and Description static java.lang.String
COPYRIGHT
static java.lang.String
defaultCommandClassName
static java.lang.String
ERRTASK_NAME
static java.lang.String
NAME
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method and Description java.util.Vector
getOutOfInventoryOrderItems()
Get out of stock order itemsvoid
setCatEntryId(java.lang.Long aCatEntryId)
Set a Catalog Entry Id to check the inventory.void
setContinue(java.lang.String aContinue)
set the value of Continuevoid
setFulfillmentCenterId(java.lang.Integer aFulfillmentCenterId)
Set a fulfillment center Id to check the inventory.void
setOrderItem(OrderItemAccessBean anOrderItem)
Set an OrderItem to check the inventory.void
setOrderItem(OrderItemAccessBean[] orderItems)
Set a list of OrderItems to check the inventory.void
setOrderItem(java.util.Vector anOrderItemList)
Set a list of OrderItems to check the inventory.void
setQuantity(java.lang.Double aQuantity)
Set a quantity to check the inventory.void
setQuantityMeasure(java.lang.String quantityMeasure)
Set a quantity measure to check the inventory (optional).void
setReturnErrorIfNoInventory(boolean returnError)
Set if error should be returned if items are out of stockvoid
setStoreId(java.lang.Integer aStoreId)
Set a store id to check the inventory.-
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.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
- See Also:
- Constant Field Values
-
NAME
static final java.lang.String NAME
- See Also:
- Constant Field Values
-
defaultCommandClassName
static final java.lang.String defaultCommandClassName
- See Also:
- Constant Field Values
-
ERRTASK_NAME
static final java.lang.String ERRTASK_NAME
- See Also:
- Constant Field Values
-
-
Method Detail
-
setCatEntryId
void setCatEntryId(java.lang.Long aCatEntryId)
Set a Catalog Entry Id to check the inventory.
-
setFulfillmentCenterId
void setFulfillmentCenterId(java.lang.Integer aFulfillmentCenterId)
Set a fulfillment center Id to check the inventory.
-
setOrderItem
void setOrderItem(OrderItemAccessBean[] orderItems)
Set a list of OrderItems to check the inventory.
-
setOrderItem
void setOrderItem(OrderItemAccessBean anOrderItem)
Set an OrderItem to check the inventory.
-
setOrderItem
void setOrderItem(java.util.Vector anOrderItemList)
Set a list of OrderItems to check the inventory.
-
setQuantity
void setQuantity(java.lang.Double aQuantity)
Set a quantity to check the inventory.
-
setQuantityMeasure
void setQuantityMeasure(java.lang.String quantityMeasure)
Set a quantity measure to check the inventory (optional).
-
setStoreId
void setStoreId(java.lang.Integer aStoreId)
Set a store id to check the inventory.
-
setReturnErrorIfNoInventory
void setReturnErrorIfNoInventory(boolean returnError)
Set if error should be returned if items are out of stock
-
getOutOfInventoryOrderItems
java.util.Vector getOutOfInventoryOrderItems()
Get out of stock order items- Returns:
- vector of OrderItemAccessBeans
-
setContinue
void setContinue(java.lang.String aContinue)
set the value of Continue
-
-