com.ibm.commerce.fulfillment.commands

Class InventoryBaseCmdImpl

java.lang.Object

com.ibm.websphere.command.TargetableCommandImpl

com.ibm.websphere.command.CacheableCommandImpl

com.ibm.commerce.command.MeasuredCacheableCommandImpl

com.ibm.commerce.command.AbstractECTargetableCommand

com.ibm.commerce.command.TaskCommandImpl

com.ibm.commerce.fulfillment.commands.InventoryBaseCmdImpl

All Implemented Interfaces:

com.ibm.commerce.command.CacheableECCommand, ECCommand, ECTargetableCommand, TaskCommand, CheckInventoryCmd, ReverseUpdateInventoryCmd, UpdateInventoryCmd, com.ibm.websphere.cache.Sizeable, com.ibm.websphere.command.CacheableCommand, com.ibm.websphere.command.Command, com.ibm.websphere.command.CommandCaller, com.ibm.websphere.command.TargetableCommand, java.io.Serializable

Direct Known Subclasses:

CheckInventoryCmdImpl, ResolveFulfillmentCenterCmdImpl, ReverseUpdateInventoryCmdImpl, UpdateInventoryCmdImpl, UpdateInventoryForOrderItemsCmdImpl

public class InventoryBaseCmdImpl
extends TaskCommandImpl
implements CheckInventoryCmd, UpdateInventoryCmd, ReverseUpdateInventoryCmd

This is the base class for the CheckInventory, UpdateInventory and ReverseUpdateInventory.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CHECK_INVENTORY
static java.lang.String	COPYRIGHT the internal copyright field
static java.lang.String	ERR_CHECK_INV
static int	NO_CHECK
static int	NO_RECOMMENDATION
static int	NO_UPDATE
static java.lang.String	REVERSE_UPDATE_INVENTORY
static java.lang.String	UPDATE_INVENTORY

Fields inherited from class com.ibm.websphere.command.TargetableCommandImpl

LOCAL

Fields inherited from interface com.ibm.commerce.fulfillment.commands.CheckInventoryCmd

defaultCommandClassName, ERRTASK_NAME, NAME

Fields inherited from interface com.ibm.commerce.fulfillment.commands.UpdateInventoryCmd

defaultCommandClassName, ERRTASK_NAME, NAME

Fields inherited from interface com.ibm.commerce.fulfillment.commands.ReverseUpdateInventoryCmd

defaultCommandClassName, ERRTASK_NAME, NAME

Constructor Summary

Constructors

Constructor and Description
InventoryBaseCmdImpl()

Method Summary

Modifier and Type	Method and Description
InventoryAccessBean	findInventory(java.lang.Long catalogEntryId, java.lang.Integer fulfillmentCenterId, java.lang.Integer inventoryStoreId) This method is to find inventory for specified catalog entry id, fulfillment center id and store id.
java.lang.Integer	getAllocatedQuantity()
java.lang.String	getIstrContinue() Returns the istrContinue.
java.util.Vector	getOutOfInventoryOrderItems() Return a Vector of OrderItems that are not available in inventory
boolean	isReadyToCallExecute() This method is called by the Targettable Command frame work before the execution of the command.
void	performExecute() Executes the main Business Logic of this Command
void	reset() reset iAllocatedQuantity
void	setAllocatedQuantity(java.lang.Integer allocatedQuantity) Set the allocated quantity which need to reverse.
void	setCatEntryId(java.lang.Long aCatEntryId) Set a Catalog Entry Id.
void	setContinue(java.lang.String aContinue) Set the istrContinue.
void	setFulfillmentCenterId(java.lang.Integer aFulfillmentCenterId) Set a fulfillment center Id.
void	setIstrContinue(java.lang.String aIstrContinue) Sets the istrContinue.
void	setOrderItem(OrderItemAccessBean anOrderItem) Set an OrderItem.
void	setOrderItem(OrderItemAccessBean[] orderItems) Set a list of OrderItems.
void	setOrderItem(java.util.Vector anOrderItemList) Set a list of OrderItems.
void	setQuantity(java.lang.Double aQuantity) Set a quantity.
void	setQuantityMeasure(java.lang.String quantityMeasure) Set a quantity measure.
void	setReturnErrorIfNoInventory(boolean returnError) Sets the iReturnError with boolean value
void	setStoreId(java.lang.Integer aStoreId) Set a store id.
void	validateParameters() Validates parameters.

Methods inherited from class com.ibm.commerce.command.AbstractECTargetableCommand

accessControlCheck, checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, execute, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getExceptionInvokeParameters, getObjectSize, getPostInvokeParameters, getPreInvokeParameters, getResources, getStoreId, getUser, getUserId, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties

Methods inherited from class com.ibm.websphere.command.CacheableCommandImpl

executeFromCache, getCaller, getEntryInfo, getId, getSharingPolicy, postExecute, preExecute, setCaller, setObjectSize, unionDependencies, updateCache

Methods inherited from class com.ibm.websphere.command.TargetableCommandImpl

getCommandTarget, getCommandTargetName, getTargetPolicy, hasOutputProperties, setCommandTarget, setCommandTargetName, setHasOutputProperties, setOutputProperties, setTargetPolicy

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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, setCommandTarget, setCommandTargetName, setOutputProperties

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, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

the internal copyright field

See Also:

Constant Field Values

ERR_CHECK_INV

public static final java.lang.String ERR_CHECK_INV

See Also:

Constant Field Values

CHECK_INVENTORY

public static final java.lang.String CHECK_INVENTORY

See Also:

Constant Field Values

UPDATE_INVENTORY

public static final java.lang.String UPDATE_INVENTORY

See Also:

Constant Field Values

REVERSE_UPDATE_INVENTORY

public static final java.lang.String REVERSE_UPDATE_INVENTORY

See Also:

Constant Field Values

NO_UPDATE

public static final int NO_UPDATE

See Also:

Constant Field Values

NO_CHECK

public static final int NO_CHECK

See Also:

Constant Field Values

NO_RECOMMENDATION

public static final int NO_RECOMMENDATION

See Also:

Constant Field Values

Constructor Detail

InventoryBaseCmdImpl

public InventoryBaseCmdImpl()

Method Detail

isReadyToCallExecute

public boolean isReadyToCallExecute()

This method is called by the Targettable Command frame work before the execution of the command. The default implementation is to return true.

Specified by:

isReadyToCallExecute in interface com.ibm.websphere.command.Command

Overrides:

isReadyToCallExecute in class AbstractECTargetableCommand

Returns:

boolean true if we can execute the command, false if we cannot execute the command.

performExecute

public void performExecute()
                    throws ECException

Executes the main Business Logic of this Command

Specified by:

performExecute in interface ECCommand

Specified by:

performExecute in interface com.ibm.websphere.command.TargetableCommand

Overrides:

performExecute in class AbstractECTargetableCommand

Throws:

ECException -

See Also:

ECCommand.performExecute()

reset

public void reset()

reset iAllocatedQuantity

Specified by:

reset in interface com.ibm.websphere.command.Command

Overrides:

reset in class AbstractECTargetableCommand

setCatEntryId

public void setCatEntryId(java.lang.Long aCatEntryId)

Set a Catalog Entry Id.

Specified by:

setCatEntryId in interface CheckInventoryCmd

Specified by:

setCatEntryId in interface ReverseUpdateInventoryCmd

Specified by:

setCatEntryId in interface UpdateInventoryCmd

Parameters:

aCatEntryId - sets iCatEntryId

setFulfillmentCenterId

public void setFulfillmentCenterId(java.lang.Integer aFulfillmentCenterId)

Set a fulfillment center Id.

Specified by:

setFulfillmentCenterId in interface CheckInventoryCmd

Specified by:

setFulfillmentCenterId in interface ReverseUpdateInventoryCmd

Specified by:

setFulfillmentCenterId in interface UpdateInventoryCmd

Parameters:

aFulfillmentCenterId - set iFulfillmentCenterId

setOrderItem

public void setOrderItem(OrderItemAccessBean[] orderItems)

Set a list of OrderItems.

Specified by:

setOrderItem in interface CheckInventoryCmd

Specified by:

setOrderItem in interface ReverseUpdateInventoryCmd

Specified by:

setOrderItem in interface UpdateInventoryCmd

Parameters:

orderItems - sets iOrderItems

setOrderItem

public void setOrderItem(OrderItemAccessBean anOrderItem)

Set an OrderItem.

Specified by:

setOrderItem in interface CheckInventoryCmd

Specified by:

setOrderItem in interface ReverseUpdateInventoryCmd

Specified by:

setOrderItem in interface UpdateInventoryCmd

Parameters:

anOrderItem - sets iOrderItems

setOrderItem

public void setOrderItem(java.util.Vector anOrderItemList)

Set a list of OrderItems.

Specified by:

setOrderItem in interface CheckInventoryCmd

Specified by:

setOrderItem in interface ReverseUpdateInventoryCmd

Specified by:

setOrderItem in interface UpdateInventoryCmd

Parameters:

anOrderItemList - sets iOrderItems

setQuantity

public void setQuantity(java.lang.Double aQuantity)

Set a quantity.

Specified by:

setQuantity in interface CheckInventoryCmd

Specified by:

setQuantity in interface ReverseUpdateInventoryCmd

Specified by:

setQuantity in interface UpdateInventoryCmd

Parameters:

aQuantity - sets iQuantity

setQuantityMeasure

public void setQuantityMeasure(java.lang.String quantityMeasure)

Set a quantity measure.

Specified by:

setQuantityMeasure in interface CheckInventoryCmd

Specified by:

setQuantityMeasure in interface ReverseUpdateInventoryCmd

Specified by:

setQuantityMeasure in interface UpdateInventoryCmd

Parameters:

quantityMeasure - sets iQuantityMeasure

setStoreId

public void setStoreId(java.lang.Integer aStoreId)

Set a store id.

Specified by:

setStoreId in interface CheckInventoryCmd

Specified by:

setStoreId in interface ReverseUpdateInventoryCmd

Specified by:

setStoreId in interface UpdateInventoryCmd

Parameters:

aStoreId - sets iStoreId

validateParameters

public void validateParameters()
                        throws ECException

Validates parameters. CatEntry and Quantity values should be associated with an OrderItem otherwise ParameterNotFoundException is thrown

Specified by:

validateParameters in interface ECCommand

Overrides:

validateParameters in class AbstractECTargetableCommand

Throws:

ECException

getOutOfInventoryOrderItems

public java.util.Vector getOutOfInventoryOrderItems()

Return a Vector of OrderItems that are not available in inventory

Specified by:

getOutOfInventoryOrderItems in interface CheckInventoryCmd

Returns:

Vector

setReturnErrorIfNoInventory

public void setReturnErrorIfNoInventory(boolean returnError)

Sets the iReturnError with boolean value

Specified by:

setReturnErrorIfNoInventory in interface CheckInventoryCmd

Parameters:

returnError - to set iReturnError

getIstrContinue

public java.lang.String getIstrContinue()

Returns the istrContinue.

Returns:

String

setIstrContinue

public void setIstrContinue(java.lang.String aIstrContinue)

Sets the istrContinue.

Parameters:

aIstrContinue - The istrContinue to set

setContinue

public void setContinue(java.lang.String aContinue)

Set the istrContinue. Used by the caller of this component to set this value

Specified by:

setContinue in interface CheckInventoryCmd

Parameters:

aContinue - to set istrContinue

getAllocatedQuantity

public java.lang.Integer getAllocatedQuantity()

Returns:

Returns the iAllocatedQuantity.

setAllocatedQuantity

public void setAllocatedQuantity(java.lang.Integer allocatedQuantity)

Description copied from interface: ReverseUpdateInventoryCmd

Set the allocated quantity which need to reverse.

Specified by:

setAllocatedQuantity in interface ReverseUpdateInventoryCmd

Parameters:

allocatedQuantity - The iAllocatedQuantity to set.

findInventory

public InventoryAccessBean findInventory(java.lang.Long catalogEntryId,
                                         java.lang.Integer fulfillmentCenterId,
                                         java.lang.Integer inventoryStoreId)
                                  throws ECException

This method is to find inventory for specified catalog entry id, fulfillment center id and store id. If related store was configured in table storerel, this method behave as below:

• find inventory for specified catalog entry id, fulfillment center id and store id. If inventory record was found, return inventory access bean
• if no inventory record was found, this method finds all related store which configured in table storerel. Then, find inventory from those related stores in turn (no sequence) until finding any inventory record

Parameters:

catalogEntryId -

fulfillmentCenterId -

inventoryStoreId -

Returns:

InventoryAccessBean the inventory access bean of the catalog entry. If no inventory, return null.

Throws:

ECException