public interface DoInventoryActionCmd extends TaskCommand
DoInventoryActionCmdImpl
.DoInventoryActionCmdImpl
Modifier and Type | Field and Description |
---|---|
static int |
ADJUST_RESERVE_INVENTORY
This usage is used to unreserve inventory
|
static int |
ALLOCATE_INVENTORY
This usage is used to allocate inventory
|
static int |
ATP_INVENTORY
Specify ATP-inventory model for store
|
static int |
CHECK_INVENTORY
This usage is used to check available quantity,
|
static java.lang.String |
COPYRIGHT
The internal copyright field.
|
static java.lang.String |
defaultCommandClassName
The default implementation class is "com.ibm.commerce.inventory.commands.DoInventoryActionCmdImpl".
|
static int |
EXTERNAL_IMS
Specify external inventory management system
|
static java.lang.String |
GENERIC_CALLER_CMD
Specify the caller command name is GenericCaller
|
static int |
GET_DEFAULT_ATP_PARAMETER
This usage is used to get Default ATPParameter
|
static int |
GET_ESTIMATE_AVAILABILITY_DATE
The usage is used to get estimated availability date
|
static int |
GET_INVENTORYCATALOG
This usage is used to get inventory catalog
|
static InventoryStatusConvertor |
INVENORY_STATUS_CONVERTOR
inventory status convertor
|
static java.lang.String |
INVENTORY_ALLOCATION_CHECK
Specify the caller command name is inventoryAllocationCheckCmd
|
static java.lang.String |
NAME
The name of this interface is "com.ibm.commerce.inventory.commands.DoInventoryActionCmd".
|
static int |
NO_ACTION
The value -9999 is to represent that there is no action set
|
static int |
NO_INVENTORY
Specify No-inventory model for store
|
static int |
NON_ATP_INVENTORY
Specify non-ATP inventory model for store
|
static java.lang.String |
ORDER_CALCULATE
Specify the caller command name is OrderCalculateCmd
|
static java.lang.String |
ORDER_CANCEL
Specify the caller command name is OrderCancelCmd
|
static java.lang.String |
ORDER_CANCEL_EXTERNAL
Specify the caller command name is OrderCancelCmd
|
static java.lang.String |
ORDER_PRE_PROCESS
Specify the caller command name is OrderPreProcessCmd
|
static java.lang.String |
ORDER_PREPARE
Specify the caller command name is OrderPrepareCmd
|
static java.lang.String |
ORDER_PROCESS
Specify the caller command name is OrderProcessCmd
|
static java.lang.String |
ORDERITEM_BASE_CMD
Specify the caller command name is OrderItemBaseCmd
|
static java.lang.String |
ORDERITEM_DELETE
Specify the caller command name is OrderItemDeleteCmd
|
static java.lang.String |
ORDERITEM_DISPLAY
Specify the caller command name is OrderItemDisplayCmd
|
static java.lang.String |
ORDERITEM_MOVE
Specify the caller command name is OrderItemMoveCmd
|
static java.lang.String |
ORDERITEM_SELECT
Specify the caller command name is OrderItemSelectCmd
|
static java.lang.String |
QUOTE_PREPARE
Specify the caller command name is QuotePrepareCmd
|
static java.lang.String |
QUOTEITEM_BASE
Specify the caller command name is QuoteItemBaseCmd
|
static java.lang.String |
RELEASE_EXPIRED_ALLOCATIONS
Specify the caller command name is ReleaseExpiredAllocationsCmd
|
static java.lang.String |
RELEASE_TO_FULFILLMENT
Specify the caller command name is ReleaseToFulfillmentCmd
|
static int |
RESERVE_INVENTORY
This usage is used to reserve inventory
|
static int |
RESOLVE_FULFILLMENTCENTER
This usage is used to resolve fulfillmentcenter
|
static int |
REVERSE_INVENTORY
This usage is used to reverse inventory
|
static int |
SHIP_ITEMS
This usage is used to ship items.
|
static int |
UPDATE_FULFILLMENTCENTER
This usage is used to resolve fulfillment center and check available inventory on the resolved fulfillment
|
Modifier and Type | Method and Description |
---|---|
int |
getAction()
This method returns the action parameters, this action is used to specify the needed inventory operation
|
ATPParameters |
getATPParms()
This method returns the input ATP parameters.
|
java.lang.String |
getCallerCommandName()
This method returns the callerCommandName
|
java.lang.Long |
getCatEntryId()
This method returns the catEntry parameters, this parameter is used for checkInventory for non-ATP
It is optional if order item is set
|
java.util.Vector |
getCatEntryIdNotAvailinInv()
Returns the Vector with Catalog Entry IDs which are not available in the requested amount in inventory
|
java.lang.String |
getContinue()
This method returns whether to continue when there is exception thrown in ResolveFulfillmentCenter
|
ATPParameters |
getDefaultATPParms()
This method returns the default ATP parameters,different caller command has different default inventory behavior
|
boolean |
getFlushNeeded()
This method returns whether flush needed for SP to catch the changes to DB
|
java.lang.Integer |
getFulfillmentCenterId()
This method returns the fulfillmentCenter parameters
It is used for action checkInventory,reverseInventory,resolveFulfillmentCenter,UpdateFulfillmentCenter, but it is optional if order item is set
|
java.util.Vector |
getFulfillmentCenters()
Returns a list of fulfillment centers that could ship an item specified by the setOrderItem method.
|
java.util.Hashtable |
getInvalidlyAllocateOrderItemsAfterAllocation()
Returns invalidlyAllocatedOrderItems
|
java.util.Vector |
getItems()
This method returns Item to resolveFulfillmentcenter
|
java.lang.String[] |
getMoveInOrders()
This method returns the output orders from where the input order items are moved to.
|
java.lang.String[] |
getMoveOutOrders()
This method returns the output orders from where the input order items are moved to.
|
java.lang.Integer |
getNeededQuantity()
Returns the needed quantity, it is converted from catalog quantity
|
java.lang.String[] |
getOrderId()
This method returns orderId, inventory component need this orderId to get the current situation for order and order item
|
OrderItemAccessBean |
getOrderItem()
This method returns orderItem
|
java.util.Hashtable |
getOrderItemFulfillmentCentersMaps()
This method returns lists of fulfillment centers which can ship items specified by the setOrderItems method.
|
java.lang.Integer |
getPreferredFulfillmentCenterId()
Return the preferred fulfillment center,it is optional for usage ResolveFulfillmentCenter and GetEstimateAvailableTime
|
java.lang.Double |
getQuantity()
return quantity to check the inventory.
|
java.lang.String |
getQuantityMeasure()
Return a quantity measure to check the inventory (optional).
|
java.lang.String |
getReservationInstance()
This method returns the reservation description identifying the instance.
|
java.lang.Long |
getReservationType()
This method returns the reservation type.
|
java.lang.Long |
getReserveId()
This method returns the reservation identifier created after executing this command.
|
java.lang.Integer |
getShippingModeId()
Return the shipping mode id.
|
java.lang.Integer |
getStoreId()
Return a store id,it is optional
|
java.util.Hashtable |
getUniqueOrderitemIdList()
This method returns the uniqueOrderItemIdList, this list records the touched order item during order item add/update
|
java.lang.String |
getUnitOfMeasure()
This method returns the unit of measure
|
void |
setAction(int action)
This method sets the action parameters.
|
void |
setATPParms(ATPParameters newATPParms)
/**
This method sets the ATP parameters.
|
void |
setCallerCommandName(java.lang.String iCmdname)
This method sets callerCommandName, different caller may have different inventory behavior
|
void |
setCatEntryId(java.lang.Long catEntry_id)
This method sets the catEntry parameters to check inventory
It is optional if order item is set
|
void |
setContinue(java.lang.String strContinue)
This method sets whether to continue
|
void |
setFlushNeeded(boolean flushNeeded)
This method sets whether flush needed after order prepare
|
void |
setFulfillmentCenterId(java.lang.Integer fulfillmentCenter_id)
This method sets the fulfillmentCenter parameters to check inventory on
It is optional if order item is set
|
void |
setItems(java.util.Vector items)
This method sets Items to check inventory
|
void |
setMoveInOrders(java.lang.String[] anstrInOrders)
This method sets a destination order for the output order items.
|
void |
setMoveOutOrders(java.lang.String[] iabOutOrders)
This method sets the orders from which order items will be moved.
|
void |
setOrderId(java.lang.String[] anstrOrderIds)
This method sets orderId, inventory component need this orderId to get the current situation for order and order item
|
void |
setOrderItem(OrderItemAccessBean iOrderItem)
This method sets orderItem, if this inventory operation is only operated on this orderItem.
|
void |
setOrderItemFulfillmentCentersMaps(java.util.Hashtable orderItemFulfillmentCentersMap)
This method sets lists of fulfillment centers which can ship items specified by the setOrderItems method.
|
void |
setPreferredFulfillmentCenterId(java.lang.Integer preferredFulfillmentCenterId)
This method sets the preferred fulfillment center.
|
void |
setQuantity(java.lang.Double quantity)
This method sets a quantity to check the inventory.
|
void |
setQuantityMeasure(java.lang.String quantityMeasure)
This method sets a quantity measure to check the inventory (optional).
|
void |
setRequestProperties(TypedProperty aRequestProperties)
Sets the request properties.
|
void |
setReservationId(java.lang.Long rid)
This method sets the reservation id for ATP enabled stores.
|
void |
setReservationInstance(java.lang.String argReservationInstance)
This method sets the reservation description identifying the instance.
|
void |
setReservationType(java.lang.Long argReservationType)
This method sets the reservation type.
|
void |
setShippingModeId(java.lang.Integer shippingModeId)
This method sets the shipping mode id.
|
void |
setStoreId(java.lang.Integer storeId)
This method sets a store id to check the inventory.
|
void |
setUniqueOrderitemIdList(java.util.Hashtable uniqueOrderItemIdList)
This method sets the uniqueOrderItemIdList
|
void |
setUnitOfMeasure(java.lang.String unitOfMeasure)
This method sets the unit of measure
|
executeFromCache, getCaller, getEntryInfo, getId, getSharingPolicy, postExecute, preExecute, setCaller, updateCache
getCommandTarget, getCommandTargetName, hasOutputProperties, performExecute, setCommandTarget, setCommandTargetName, setOutputProperties
checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getPostInvokeParameters, getPreInvokeParameters, getResources, getUser, getUserId, performExecute, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters
static final java.lang.String COPYRIGHT
static final java.lang.String NAME
static final java.lang.String defaultCommandClassName
static final int NO_ACTION
static final int GET_DEFAULT_ATP_PARAMETER
static final int CHECK_INVENTORY
static final int RESOLVE_FULFILLMENTCENTER
static final int UPDATE_FULFILLMENTCENTER
static final int ALLOCATE_INVENTORY
static final int REVERSE_INVENTORY
static final int GET_ESTIMATE_AVAILABILITY_DATE
static final int RESERVE_INVENTORY
static final int ADJUST_RESERVE_INVENTORY
static final int GET_INVENTORYCATALOG
static final int SHIP_ITEMS
static final java.lang.String ORDERITEM_BASE_CMD
static final java.lang.String GENERIC_CALLER_CMD
static final java.lang.String ORDER_PREPARE
static final java.lang.String ORDER_PRE_PROCESS
static final java.lang.String ORDER_PROCESS
static final java.lang.String INVENTORY_ALLOCATION_CHECK
static final java.lang.String ORDERITEM_SELECT
static final java.lang.String ORDER_CALCULATE
static final java.lang.String ORDERITEM_MOVE
static final java.lang.String ORDERITEM_DISPLAY
static final java.lang.String ORDERITEM_DELETE
static final java.lang.String ORDER_CANCEL
static final java.lang.String ORDER_CANCEL_EXTERNAL
static final java.lang.String QUOTEITEM_BASE
static final java.lang.String QUOTE_PREPARE
static final java.lang.String RELEASE_EXPIRED_ALLOCATIONS
static final java.lang.String RELEASE_TO_FULFILLMENT
static final int ATP_INVENTORY
static final int NON_ATP_INVENTORY
static final int NO_INVENTORY
static final int EXTERNAL_IMS
static final InventoryStatusConvertor INVENORY_STATUS_CONVERTOR
void setRequestProperties(TypedProperty aRequestProperties)
aRequestProperties
- request properties.void setATPParms(ATPParameters newATPParms)
newATPParms
- ATPParametersATPParameters getATPParms()
ATPParameters getDefaultATPParms()
int getAction()
void setAction(int action)
action
- java.lang.String getCallerCommandName()
void setCallerCommandName(java.lang.String iCmdname)
iCmdname
- java.lang.Long getCatEntryId()
void setCatEntryId(java.lang.Long catEntry_id)
catEntry_id
- java.lang.Integer getFulfillmentCenterId()
void setFulfillmentCenterId(java.lang.Integer fulfillmentCenter_id)
fulfillmentCenter_id
- OrderItemAccessBean getOrderItem()
void setOrderItem(OrderItemAccessBean iOrderItem)
iOrderItem
- The orderItem to be operated onvoid setOrderItemFulfillmentCentersMaps(java.util.Hashtable orderItemFulfillmentCentersMap)
orderItemFulfillmentCentersMap
- java.lang.Integer getPreferredFulfillmentCenterId()
void setPreferredFulfillmentCenterId(java.lang.Integer preferredFulfillmentCenterId)
preferredFulfillmentCenterId
- the identifier of the preferred fulfillment center.java.lang.Integer getShippingModeId()
void setShippingModeId(java.lang.Integer shippingModeId)
shippingModeId
- java.lang.Double getQuantity()
void setQuantity(java.lang.Double quantity)
quantity
- java.lang.String getQuantityMeasure()
void setQuantityMeasure(java.lang.String quantityMeasure)
quantityMeasure
- java.lang.Integer getStoreId()
getStoreId
in interface ECCommand
void setStoreId(java.lang.Integer storeId)
storeId
- integerjava.util.Vector getItems()
void setItems(java.util.Vector items)
items
- java.lang.String getContinue()
void setContinue(java.lang.String strContinue)
strContinue
- java.lang.String getUnitOfMeasure()
void setUnitOfMeasure(java.lang.String unitOfMeasure)
unitOfMeasure
- java.lang.String[] getOrderId()
void setOrderId(java.lang.String[] anstrOrderIds)
anstrOrderIds
- java.lang.String getReservationInstance()
void setReservationInstance(java.lang.String argReservationInstance)
argReservationInstance
- reservation descriptionjava.lang.Long getReservationType()
INVRSRVTYP
table.void setReservationType(java.lang.Long argReservationType)
INVRSRVTYP
table.argReservationType
- reservation typevoid setReservationId(java.lang.Long rid)
rid
- java.lang.String[] getMoveInOrders()
void setMoveInOrders(java.lang.String[] anstrInOrders)
anstrInOrders
- String[]java.lang.String[] getMoveOutOrders()
void setMoveOutOrders(java.lang.String[] iabOutOrders)
iabOutOrders
- String[]java.util.Vector getCatEntryIdNotAvailinInv()
java.util.Hashtable getUniqueOrderitemIdList()
void setUniqueOrderitemIdList(java.util.Hashtable uniqueOrderItemIdList)
uniqueOrderItemIdList
- boolean getFlushNeeded()
void setFlushNeeded(boolean flushNeeded)
flushNeeded
- java.util.Hashtable getOrderItemFulfillmentCentersMaps()
java.util.Vector getFulfillmentCenters()
java.lang.Integer getNeededQuantity()
java.lang.Long getReserveId()
java.util.Hashtable getInvalidlyAllocateOrderItemsAfterAllocation() throws ECException
ECException