atg.commerce.inventory

Class CachingInventoryManager

java.lang.Object

atg.commerce.inventory.CachingInventoryManager

All Implemented Interfaces:

InventoryManager, LocationInventoryManager

public class CachingInventoryManager
extends java.lang.Object
implements LocationInventoryManager

This class is configured with a datasource repository and a cache, and caches SKU items so that data may be fetched quickly and easily. Purchase requests are amassed and committed all at once.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION
static int	UNCACHED_INVENTORY_MANAGER_NOT_SET return code when uncachedInventoryManger is not set

Fields inherited from interface atg.commerce.inventory.InventoryManager

AVAILABILITY_STATUS_BACKORDERABLE, AVAILABILITY_STATUS_DERIVED, AVAILABILITY_STATUS_DISCONTINUED, AVAILABILITY_STATUS_IN_STOCK, AVAILABILITY_STATUS_OUT_OF_STOCK, AVAILABILITY_STATUS_PREORDERABLE, INVENTORY_STATUS_FAIL, INVENTORY_STATUS_INSUFFICIENT_SUPPLY, INVENTORY_STATUS_ITEM_NOT_FOUND, INVENTORY_STATUS_SUCCEED

Constructor Summary

Constructors

Constructor and Description
CachingInventoryManager()

Method Summary

Methods

Modifier and Type	Method and Description
void	acquireInventoryLocks(java.util.List pItemIds) Acquires locks for the inventory items that apply to the given ids.
void	acquireInventoryLocks(java.util.List pItemIds, java.lang.String pLocationId) Acquires locks for the inventory items that apply to the given ids.
int	backorder(java.lang.String pId, long pHowMany) Backorder an item.
int	backorder(java.lang.String pId, long pHowMany, java.lang.String pLocationId) Backorder an item.
int	decreaseBackorderLevel(java.lang.String pId, long pNumber) Decrease an item's backorder level by the specified amount.
int	decreaseBackorderLevel(java.lang.String pId, long pNumber, java.lang.String pLocationId) Decrease an item's backorder level by the specified amount.
int	decreasePreorderLevel(java.lang.String pId, long pNumber) Decrease an item's preorder level by the specified amount.
int	decreasePreorderLevel(java.lang.String pId, long pNumber, java.lang.String pLocationId) Decrease an item's preorder level by the specified amount.
int	decreaseStockLevel(java.lang.String pId, long pNumber) Decrease an item's stock level by the specified amount.
int	decreaseStockLevel(java.lang.String pId, long pNumber, java.lang.String pLocationId) Decrease an item's stock level by the specified amount.
void	flushCache() Invalidate all the entries in the cache.
void	flushCache(java.util.List pItemIds) Invalidates the cache entries for the given ids.
void	flushCache(java.util.List<java.lang.String> pItemIds, java.util.List<java.lang.String> pLocationIds) Invalidates the cache for all of the given item and location combinations
void	flushCache(java.util.List pItemIds, java.lang.String pLocationId) Invalidates the cache for all of the given items at the given location
java.lang.String	getDelimiter()
AbstractCache	getInventoryCache() Returns property InventoryCache
java.lang.String	getInventoryName() A displayable name for thie inventory manager.
protected java.lang.String	getKey(java.lang.String pId) Get the cache key for the given itemId
protected java.lang.String	getKey(java.lang.String pId, java.lang.String pLocationId) Get the cache key for the given item and location
InventoryManager	getUncachedInventoryManager() Returns property UncachedInventoryManager
int	increaseBackorderLevel(java.lang.String pId, long pNumber) Increase an item's backorder level by the specified number.
int	increaseBackorderLevel(java.lang.String pId, long pNumber, java.lang.String pLocationId) Increase an item's backorder level by the specified number.
int	increasePreorderLevel(java.lang.String pId, long pNumber) Increase an item's preorder level by the specified number.
int	increasePreorderLevel(java.lang.String pId, long pNumber, java.lang.String pLocationId) Increase an item's preorder level by the specified number.
int	increaseStockLevel(java.lang.String pId, long pNumber) Increase an item's stock level by the specified number.
int	increaseStockLevel(java.lang.String pId, long pNumber, java.lang.String pLocationId) Increase an item's stock level by the specified number.
int	inventoryWasUpdated(java.util.List pItemIds) Informs the inventory manager that the given ids are now available.
int	inventoryWasUpdated(java.util.List pItemIds, java.lang.String pLocationId) Informs the inventory manager that the given ids are now available.
int	preorder(java.lang.String pId, long pHowMany) Preorder an item.
int	preorder(java.lang.String pId, long pHowMany, java.lang.String pLocationId) Preorder an item.
int	purchase(java.lang.String pId, long pHowMany) Actually purchases a product.
int	purchase(java.lang.String pId, long pHowMany, java.lang.String pLocationId) Actually purchases a product.
int	purchaseOffBackorder(java.lang.String pId, long pHowMany) Actually purchases a product.
int	purchaseOffBackorder(java.lang.String pId, long pHowMany, java.lang.String pLocationId) Actually purchases a product.
int	purchaseOffPreorder(java.lang.String pId, long pHowMany) Actually purchases a product.
int	purchaseOffPreorder(java.lang.String pId, long pHowMany, java.lang.String pLocationId) Actually purchases a product.
java.util.Date	queryAvailabilityDate(java.lang.String pId) Return the availability date of an item.
java.util.Date	queryAvailabilityDate(java.lang.String pId, java.lang.String pLocationId) Return the availability date of an item.
int	queryAvailabilityStatus(java.lang.String pId) Return the availability status of a given item.
int	queryAvailabilityStatus(java.lang.String pId, java.lang.String pLocationId) Return the availability status of a given item.
AvailableToPromise	queryAvailableToPromise(java.lang.String pItemId, java.lang.String pLocationId) Returns Available To Promise information for a given id and location
long	queryBackorderLevel(java.lang.String pId) Return how many of a given item can be backorder.
long	queryBackorderLevel(java.lang.String pId, java.lang.String pLocationId) Return how many of a given item are available for backorder.
long	queryBackorderThreshold(java.lang.String pId) Return the threshold associated with backorderLevel
long	queryBackorderThreshold(java.lang.String pId, java.lang.String pLocationId) Return the threshold associated with backorderLevel
java.util.Collection<InventoryInfo>	queryInventoryInformation(java.util.Collection<java.lang.String> pItemIds, java.util.Collection<java.lang.String> pLocationIds) Returns an InventoryInfo object for every id at every location
java.util.Collection<InventoryInfo>	queryInventoryInformation(java.util.Collection<java.lang.String> pItemIds, java.lang.String pLocationId) Returns an InventoryInfo object for each id at the given location
java.util.Collection<InventoryInfo>	queryInventoryInformation(java.lang.String pId, java.util.Collection<java.lang.String> pLocationIds) Returns an InventoryInfo object for the given id at each given location
InventoryInfo	queryInventoryInformation(java.lang.String pId, java.lang.String pLocationId) Returns an InventoryInfo object for the given id and location
long	queryPreorderLevel(java.lang.String pId) Return how many of a given item can be preorder.
long	queryPreorderLevel(java.lang.String pId, java.lang.String pLocationId) Return how many of a given item are available for preorder.
long	queryPreorderThreshold(java.lang.String pId) Return the threshold associated with preorderLevel
long	queryPreorderThreshold(java.lang.String pId, java.lang.String pLocationId) Return the threshold associated with preorderLevel
long	queryStockLevel(java.lang.String pId) Return how many of a given item are in the system.
long	queryStockLevel(java.lang.String pId, java.lang.String pLocationId) Return how many of a given item are in the system.
long	queryStockThreshold(java.lang.String pId) Return the threshold associated with stockLevel.
long	queryStockThreshold(java.lang.String pId, java.lang.String pLocationId) Return the threshold associated with stockLevel.
void	releaseInventoryLocks(java.util.List pItemIds) Release locks for the inventory items that apply to the given ids.
void	releaseInventoryLocks(java.util.List pItemIds, java.lang.String pLocationId) Release locks for the inventory items that apply to the given ids.
int	setAvailabilityDate(java.lang.String pId, java.util.Date pDate) Set an item's availability date.
int	setAvailabilityDate(java.lang.String pId, java.util.Date pDate, java.lang.String pLocationId) Set an item's availability date.
int	setAvailabilityStatus(java.lang.String pId, int pStatus) Set an item's availability status.
int	setAvailabilityStatus(java.lang.String pId, int pStatus, java.lang.String pLocationId) Set an item's availability status.
int	setBackorderLevel(java.lang.String pId, long pNumber) Set an item's backorder level to the specified number.
int	setBackorderLevel(java.lang.String pId, long pNumber, java.lang.String pLocationId) Set an item's backorder level to the specified number.
int	setBackorderThreshold(java.lang.String pId, long pNumber) Set an item's backorder level threshold.
int	setBackorderThreshold(java.lang.String pId, long pNumber, java.lang.String pLocationId) Set an item's backorder level threshold.
void	setDelimiter(java.lang.String pDelimiter)
void	setInventoryCache(AbstractCache pInventoryCache) Sets property InventoryCache
void	setInventoryName(java.lang.String pInventoryName)
int	setPreorderLevel(java.lang.String pId, long pNumber) Set an item's preorder level to the specified number.
int	setPreorderLevel(java.lang.String pId, long pNumber, java.lang.String pLocationId) Set an item's preorder level to the specified number.
int	setPreorderThreshold(java.lang.String pId, long pNumber) Set an item's preorder level threshold.
int	setPreorderThreshold(java.lang.String pId, long pNumber, java.lang.String pLocationId) Set an item's preorder level threshold.
int	setStockLevel(java.lang.String pId, long pNumber) Set an item's stock level to the specified number.
int	setStockLevel(java.lang.String pId, long pNumber, java.lang.String pLocationId) Set an item's stock level to the specified number.
int	setStockThreshold(java.lang.String pId, long pNumber) Set an item's stock level threshold.
int	setStockThreshold(java.lang.String pId, long pNumber, java.lang.String pLocationId) Set an item's stock level threshold.
void	setUncachedInventoryManager(InventoryManager pUncachedInventoryManager) Sets property UncachedInventoryManager

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

UNCACHED_INVENTORY_MANAGER_NOT_SET

public static final int UNCACHED_INVENTORY_MANAGER_NOT_SET

return code when uncachedInventoryManger is not set

See Also:

Constant Field Values

Constructor Detail

CachingInventoryManager

public CachingInventoryManager()

Method Detail

setInventoryCache

public void setInventoryCache(AbstractCache pInventoryCache)

Sets property InventoryCache

getInventoryCache

public AbstractCache getInventoryCache()

Returns property InventoryCache

setUncachedInventoryManager

public void setUncachedInventoryManager(InventoryManager pUncachedInventoryManager)

Sets property UncachedInventoryManager

getUncachedInventoryManager

public InventoryManager getUncachedInventoryManager()

Returns property UncachedInventoryManager

setDelimiter

public void setDelimiter(java.lang.String pDelimiter)

getDelimiter

public java.lang.String getDelimiter()

setInventoryName

public void setInventoryName(java.lang.String pInventoryName)

getInventoryName

public java.lang.String getInventoryName()

A displayable name for thie inventory manager.

Specified by:

getInventoryName in interface InventoryManager

purchase

public int purchase(java.lang.String pId,
           long pHowMany,
           java.lang.String pLocationId)
             throws InventoryException

Actually purchases a product. The backend inventory system should register that a purchase has been made.

Specified by:

purchase in interface LocationInventoryManager

Parameters:

pId - the id of the item involved

pLocationId - the location of the inventory (null is default warehouse)

Returns:

INVENTORY_STATUS_SUCCEED or INVENTORY_STATUS_FAIL

Throws:

InventoryException - if there was a problem during the purchase process.

purchaseOffBackorder

public int purchaseOffBackorder(java.lang.String pId,
                       long pHowMany,
                       java.lang.String pLocationId)
                         throws InventoryException

Actually purchases a product. The backend inventory system should register that a purchase has been made. If the purchase succeeds, the item's backorderLevel is increased appropriately.

Specified by:

purchaseOffBackorder in interface LocationInventoryManager

Parameters:

pId - the id of the item involved

pLocationId - the location of the inventory (null is default warehouse)

Returns:

INVENTORY_STATUS_SUCCEED or INVENTORY_STATUS_FAIL

Throws:

InventoryException - if there was a problem during the purchase process.

purchaseOffPreorder

public int purchaseOffPreorder(java.lang.String pId,
                      long pHowMany,
                      java.lang.String pLocationId)
                        throws InventoryException

Actually purchases a product. The backend inventory system should register that a purchase has been made. If the purchase succeeds, the item's preorderLevel is increased appropriately.

Specified by:

purchaseOffPreorder in interface LocationInventoryManager

Parameters:

pId - the id of the item involved

pLocationId - the location of the inventory (null is default warehouse)

Returns:

INVENTORY_STATUS_SUCCEED or INVENTORY_STATUS_FAIL

Throws:

InventoryException - if there was a problem during the purchase process.

preorder

public int preorder(java.lang.String pId,
           long pHowMany,
           java.lang.String pLocationId)
             throws InventoryException

Preorder an item. The usual implication of preordering is that the retailer has never had the item in stock, but promises to have the item soon.

Specified by:

preorder in interface LocationInventoryManager

Parameters:

pId - the id of the item involved

pLocationId - the location of the inventory (null is default warehouse)

Returns:

INVENTORY_STATUS_SUCCEED or INVENTORY_STATUS_FAIL

Throws:

InventoryException - if there was a problem in trying to preorder the item

backorder

public int backorder(java.lang.String pId,
            long pHowMany,
            java.lang.String pLocationId)
              throws InventoryException

Backorder an item. The usual implication of this is very similar to preorder, except that the store did at one time have this item, it's just out of it now.

Specified by:

backorder in interface LocationInventoryManager

Parameters:

pId - the id of the item involved

pLocationId - the location of the inventory (null is default warehouse)

Returns:

INVENTORY_STATUS_SUCCEED or INVENTORY_STATUS_FAIL

Throws:

InventoryException - if there was a problem with the backordering process.

setStockLevel

public int setStockLevel(java.lang.String pId,
                long pNumber,
                java.lang.String pLocationId)
                  throws InventoryException

Set an item's stock level to the specified number.

Specified by:

setStockLevel in interface LocationInventoryManager

Parameters:

pId - the id of the item involved

pNumber - the number of the given item to restock

pLocationId - the location of the inventory (null is default warehouse)

Returns:

INVENTORY_STATUS_SUCCEED or INVENTORY_STATUS_FAIL

Throws:

InventoryException - if there was a problem trying to restock

setBackorderLevel

public int setBackorderLevel(java.lang.String pId,
                    long pNumber,
                    java.lang.String pLocationId)
                      throws InventoryException

Set an item's backorder level to the specified number.

Specified by:

setBackorderLevel in interface LocationInventoryManager

Parameters:

pId - the id of the item involved

pNumber - the number of the given item to restock

pLocationId - the location of the inventory (null is default warehouse)

Returns:

INVENTORY_STATUS_SUCCEED or INVENTORY_STATUS_FAIL

Throws:

InventoryException - if there was a problem trying to restock

setPreorderLevel

public int setPreorderLevel(java.lang.String pId,
                   long pNumber,
                   java.lang.String pLocationId)
                     throws InventoryException

Set an item's preorder level to the specified number.

Specified by:

setPreorderLevel in interface LocationInventoryManager

Parameters:

pId - the id of the item involved

pNumber - the number of the given item to restock

pLocationId - the location of the inventory (null is default warehouse)

Returns:

INVENTORY_STATUS_SUCCEED or INVENTORY_STATUS_FAIL

Throws:

InventoryException - if there was a problem trying to restock

increaseStockLevel

public int increaseStockLevel(java.lang.String pId,
                     long pNumber,
                     java.lang.String pLocationId)
                       throws InventoryException

Increase an item's stock level by the specified number.

Specified by:

increaseStockLevel in interface LocationInventoryManager

Parameters:

pId - the id of the item involved

pNumber - the number of items to add to the current stock level

pLocationId - the location of the inventory (null is default warehouse)

Returns:

INVENTORY_STATUS_SUCCEED or INVENTORY_STATUS_FAIL

Throws:

InventoryException - if there was a problem trying to restock

decreaseStockLevel

public int decreaseStockLevel(java.lang.String pId,
                     long pNumber,
                     java.lang.String pLocationId)
                       throws InventoryException

Decrease an item's stock level by the specified amount. This method is to be used for inventory adjustments, not for purchases. For purchases, use the purchase(String pId, long pHowMany) method.

Specified by:

decreaseStockLevel in interface LocationInventoryManager

Parameters:

pId - the id of the item involved

pNumber - the number of items to decrease from the current stock level

pLocationId - the location of the inventory (null is default warehouse)

Returns:

INVENTORY_STATUS_SUCCEED or INVENTORY_STATUS_FAIL

Throws:

InventoryException - if there was a problem trying to restock

increaseBackorderLevel

public int increaseBackorderLevel(java.lang.String pId,
                         long pNumber,
                         java.lang.String pLocationId)
                           throws InventoryException

Increase an item's backorder level by the specified number.

Specified by:

increaseBackorderLevel in interface LocationInventoryManager

Parameters:

pId - the id of the item involved

pNumber - the number of items to add to the current stock level

pLocationId - the location of the inventory (null is default warehouse)

Returns:

INVENTORY_STATUS_SUCCEED or INVENTORY_STATUS_FAIL

Throws:

InventoryException - if there was a problem trying to restock

decreaseBackorderLevel

public int decreaseBackorderLevel(java.lang.String pId,
                         long pNumber,
                         java.lang.String pLocationId)
                           throws InventoryException

Decrease an item's backorder level by the specified amount.

Specified by:

decreaseBackorderLevel in interface LocationInventoryManager

Parameters:

pId - the id of the item involved

pNumber - the number of items to decrease from the current stock level

pLocationId - the location of the inventory (null is default warehouse)

Returns:

INVENTORY_STATUS_SUCCEED or INVENTORY_STATUS_FAIL

Throws:

InventoryException - if there was a problem trying to restock

increasePreorderLevel

public int increasePreorderLevel(java.lang.String pId,
                        long pNumber,
                        java.lang.String pLocationId)
                          throws InventoryException

Increase an item's preorder level by the specified number.

Specified by:

increasePreorderLevel in interface LocationInventoryManager

Parameters:

pId - the id of the item involved

pNumber - the number of items to add to the current stock level

pLocationId - the location of the inventory (null is default warehouse)

Returns:

INVENTORY_STATUS_SUCCEED or INVENTORY_STATUS_FAIL

Throws:

InventoryException - if there was a problem trying to restock

decreasePreorderLevel

public int decreasePreorderLevel(java.lang.String pId,
                        long pNumber,
                        java.lang.String pLocationId)
                          throws InventoryException

Decrease an item's preorder level by the specified amount.

Specified by:

decreasePreorderLevel in interface LocationInventoryManager

Parameters:

pId - the id of the item involved

pNumber - the number of items to decrease from the current stock level

pLocationId - the location of the inventory (null is default warehouse)

Returns:

INVENTORY_STATUS_SUCCEED or INVENTORY_STATUS_FAIL

Throws:

InventoryException - if there was a problem trying to restock

setStockThreshold

public int setStockThreshold(java.lang.String pId,
                    long pNumber,
                    java.lang.String pLocationId)
                      throws InventoryException

Set an item's stock level threshold.

Specified by:

setStockThreshold in interface LocationInventoryManager

Parameters:

pId - the id of the item involved

pNumber - the number of the given item to restock

pLocationId - the location of the inventory (null is default warehouse)

Returns:

INVENTORY_STATUS_SUCCEED or INVENTORY_STATUS_FAIL

Throws:

InventoryException - if there was a problem trying to restock

setBackorderThreshold

public int setBackorderThreshold(java.lang.String pId,
                        long pNumber,
                        java.lang.String pLocationId)
                          throws InventoryException

Set an item's backorder level threshold.

Specified by:

setBackorderThreshold in interface LocationInventoryManager

Parameters:

pId - the id of the item involved

pNumber - the number of the given item to restock

pLocationId - the location of the inventory (null is default warehouse)

Returns:

INVENTORY_STATUS_SUCCEED or INVENTORY_STATUS_FAIL

Throws:

InventoryException - if there was a problem trying to restock

setPreorderThreshold

public int setPreorderThreshold(java.lang.String pId,
                       long pNumber,
                       java.lang.String pLocationId)
                         throws InventoryException

Set an item's preorder level threshold.

Specified by:

setPreorderThreshold in interface LocationInventoryManager

Parameters:

pId - the id of the item involved

pNumber - the number of the given item to restock

pLocationId - the location of the inventory (null is default warehouse)

Returns:

INVENTORY_STATUS_SUCCEED or INVENTORY_STATUS_FAIL

Throws:

InventoryException - if there was a problem trying to restock

setAvailabilityStatus

public int setAvailabilityStatus(java.lang.String pId,
                        int pStatus,
                        java.lang.String pLocationId)
                          throws InventoryException

Set an item's availability status.

Specified by:

setAvailabilityStatus in interface LocationInventoryManager

Parameters:

pId - the id of the item involved

pStatus - the new status (one of AVAILABILITY_STATUS_IN_STOCK, AVAILABILITY_STATUS_BACKORDERABLE, AVAILABILITY_STATUS_PREORDERABLE, AVAILABILITY_STATUS_OUT_OF_STOCK, AVAILABILITY_STATUS_DISCONTINUED, or AVAILABILITY_STATUS_DERIVED)

pLocationId - the location of the inventory (null is default warehouse)

Returns:

INVENTORY_STATUS_SUCCEED, INVENTORY_STATUS_ITEM_NOT_FOUND, or INVENTORY_STATUS_FAIL

Throws:

InventoryException

setAvailabilityDate

public int setAvailabilityDate(java.lang.String pId,
                      java.util.Date pDate,
                      java.lang.String pLocationId)
                        throws InventoryException

Set an item's availability date.

Specified by:

setAvailabilityDate in interface LocationInventoryManager

Parameters:

pId - the id of the item involved

pDate - The new availability date for the item.

pLocationId - the location of the inventory (null is default warehouse)

Returns:

INVENTORY_STATUS_SUCCEED, INVENTORY_STATUS_ITEM_NOT_FOUND, or INVENTORY_STATUS_FAIL

Throws:

InventoryException

queryStockThreshold

public long queryStockThreshold(java.lang.String pId,
                       java.lang.String pLocationId)
                         throws InventoryException

Return the threshold associated with stockLevel.

Specified by:

queryStockThreshold in interface LocationInventoryManager

pLocationId - the location of the inventory (null is default warehouse)

Returns:

how many items, with the given id, are available for purchase

Throws:

InventoryException - if there was a problem determining the number

queryBackorderThreshold

public long queryBackorderThreshold(java.lang.String pId,
                           java.lang.String pLocationId)
                             throws InventoryException

Return the threshold associated with backorderLevel

Specified by:

queryBackorderThreshold in interface LocationInventoryManager

pLocationId - the location of the inventory (null is default warehouse)

Returns:

how many items, with the given id, are available for purchase

Throws:

InventoryException - if there was a problem determining the number

queryPreorderThreshold

public long queryPreorderThreshold(java.lang.String pId,
                          java.lang.String pLocationId)
                            throws InventoryException

Return the threshold associated with preorderLevel

Specified by:

queryPreorderThreshold in interface LocationInventoryManager

pLocationId - the location of the inventory (null is default warehouse)

Returns:

how many items, with the given id, are available for purchase

Throws:

InventoryException - if there was a problem determining the number

queryStockLevel

public long queryStockLevel(java.lang.String pId,
                   java.lang.String pLocationId)
                     throws InventoryException

Return how many of a given item are in the system.

Specified by:

queryStockLevel in interface LocationInventoryManager

pLocationId - the location of the inventory (null is default warehouse)

Returns:

how many items, with the given id, are available for purchase

Throws:

InventoryException - if there was a problem determining the number

queryPreorderLevel

public long queryPreorderLevel(java.lang.String pId,
                      java.lang.String pLocationId)
                        throws InventoryException

Return how many of a given item are available for preorder.

Specified by:

queryPreorderLevel in interface LocationInventoryManager

pLocationId - the location of the inventory (null is default warehouse)

Returns:

how many items, with the given id, are available for preorder

Throws:

InventoryException - if there was a problem determining the number

queryBackorderLevel

public long queryBackorderLevel(java.lang.String pId,
                       java.lang.String pLocationId)
                         throws InventoryException

Return how many of a given item are available for backorder.

Specified by:

queryBackorderLevel in interface LocationInventoryManager

pLocationId - the location of the inventory (null is default warehouse)

Returns:

how many items, with the given id, are available for backorder

Throws:

InventoryException - if there was a problem determining the number

queryAvailabilityStatus

public int queryAvailabilityStatus(java.lang.String pId,
                          java.lang.String pLocationId)
                            throws InventoryException

Return the availability status of a given item. An item can be in one of four states:

Specified by:

queryAvailabilityStatus in interface LocationInventoryManager

Parameters:

pId - The id of the item involved.

pLocationId - the location of the inventory (null is default warehouse)

Returns:

AVAILABILITY_STATUS_IN_STOCK

Throws:

InventoryException - if there was a problem determining the status of the item

queryAvailabilityDate

public java.util.Date queryAvailabilityDate(java.lang.String pId,
                                   java.lang.String pLocationId)
                                     throws InventoryException

Return the availability date of an item.

Specified by:

queryAvailabilityDate in interface LocationInventoryManager

pLocationId - the location of the inventory (null is default warehouse)

Returns:

the date that the item will be available for puchase if the item's availability status is not AVAILABILITY_STATUS_IN_STOCK. If the item's availability status is AVAILABILITY_STATUS_IN_STOCK, then we return null.

Throws:

InventoryException - if there was a problem determining the date

inventoryWasUpdated

public int inventoryWasUpdated(java.util.List pItemIds,
                      java.lang.String pLocationId)
                        throws InventoryException

Informs the inventory manager that the given ids are now available. Some implementations of the InventoryManager may send a message informing other systems that some items that were previously unavailable are now available.

Specified by:

inventoryWasUpdated in interface LocationInventoryManager

Parameters:

pItemIds - The items with recently added inventory

pLocationId - the location of the inventory (null is default warehouse)

Throws:

InventoryException

acquireInventoryLocks

public void acquireInventoryLocks(java.util.List pItemIds,
                         java.lang.String pLocationId)
                           throws InventoryException

Acquires locks for the inventory items that apply to the given ids.

Specified by:

acquireInventoryLocks in interface LocationInventoryManager

pLocationId - the location of the inventory (null is default warehouse)

Throws:

InventoryException

releaseInventoryLocks

public void releaseInventoryLocks(java.util.List pItemIds,
                         java.lang.String pLocationId)
                           throws InventoryException

Release locks for the inventory items that apply to the given ids.

Specified by:

releaseInventoryLocks in interface LocationInventoryManager

pLocationId - the location of the inventory (null is default warehouse)

Throws:

InventoryException

queryInventoryInformation

public java.util.Collection<InventoryInfo> queryInventoryInformation(java.util.Collection<java.lang.String> pItemIds,
                                                            java.lang.String pLocationId)
                                                              throws InventoryException

Description copied from interface: LocationInventoryManager

Returns an InventoryInfo object for each id at the given location

Specified by:

queryInventoryInformation in interface LocationInventoryManager

Parameters:

pItemIds - The items to find inventory information for.

pLocationId - the location of the inventory (null is default warehouse)

Returns:

A list of inventory info records.

Throws:

InventoryException

queryInventoryInformation

public java.util.Collection<InventoryInfo> queryInventoryInformation(java.lang.String pId,
                                                            java.util.Collection<java.lang.String> pLocationIds)
                                                              throws InventoryException

Description copied from interface: LocationInventoryManager

Returns an InventoryInfo object for the given id at each given location

Specified by:

queryInventoryInformation in interface LocationInventoryManager

Parameters:

pId - The item Id to find inventory info for

pLocationIds - The locations to find inventory information for.

Returns:

A list of inventory info records.

Throws:

InventoryException

queryInventoryInformation

public java.util.Collection<InventoryInfo> queryInventoryInformation(java.util.Collection<java.lang.String> pItemIds,
                                                            java.util.Collection<java.lang.String> pLocationIds)
                                                              throws InventoryException

Description copied from interface: LocationInventoryManager

Returns an InventoryInfo object for every id at every location

Specified by:

queryInventoryInformation in interface LocationInventoryManager

Parameters:

pItemIds - The items to find inventory information for.

pLocationIds - The locations to find inventory information for.

Returns:

A list of inventory info records.

Throws:

InventoryException

queryInventoryInformation

public InventoryInfo queryInventoryInformation(java.lang.String pId,
                                      java.lang.String pLocationId)
                                        throws InventoryException

Description copied from interface: LocationInventoryManager

Returns an InventoryInfo object for the given id and location

Specified by:

queryInventoryInformation in interface LocationInventoryManager

Parameters:

pId - The item Id to find inventory info for

pLocationId - the location of the inventory (null is default warehouse)

Returns:

The inventory information for the given id and location

Throws:

InventoryException

queryAvailableToPromise

public AvailableToPromise queryAvailableToPromise(java.lang.String pItemId,
                                         java.lang.String pLocationId)
                                           throws InventoryException

Description copied from interface: LocationInventoryManager

Returns Available To Promise information for a given id and location

Specified by:

queryAvailableToPromise in interface LocationInventoryManager

Parameters:

pItemId - The item to find the ATP information for

pLocationId - The location to find ATP information for.

Returns:

The Availability information

Throws:

InventoryException

flushCache

public void flushCache()

Invalidate all the entries in the cache.

flushCache

public void flushCache(java.util.List pItemIds)

Invalidates the cache entries for the given ids. If the list is null, invalidate all the cache entries.

Parameters:

pItemIds - The list of ids whose entries should be invalidated

flushCache

public void flushCache(java.util.List<java.lang.String> pItemIds,
              java.util.List<java.lang.String> pLocationIds)

Invalidates the cache for all of the given item and location combinations

Parameters:

pItemIds - the item ids to flush

pLocationIds - the locations to flush

flushCache

public void flushCache(java.util.List pItemIds,
              java.lang.String pLocationId)

Invalidates the cache for all of the given items at the given location

Parameters:

pItemIds - the item ids to flush (null is all items)

pLocationId - the location to flush items for

getKey

protected java.lang.String getKey(java.lang.String pId)

Get the cache key for the given itemId

Parameters:

pId - the item id

Returns:

the cache key for the item

getKey

protected java.lang.String getKey(java.lang.String pId,
                      java.lang.String pLocationId)

Get the cache key for the given item and location

Parameters:

pId - the item id

pLocationId - the location

Returns:

the cache key for the given item and location id.

purchase

public int purchase(java.lang.String pId,
           long pHowMany)
             throws InventoryException

Description copied from interface: InventoryManager

Actually purchases a product. The backend inventory system should register that a purchase has been made.

Specified by:

purchase in interface InventoryManager

Parameters:

pId - the id of the item involved

Returns:

One of the following:

• INVENTORY_STATUS_SUCCEED
• INVENTORY_STATUS_INSUFFICIENT_SUPPLY
• INVENTORY_STATUS_ITEM_NOT_FOUND
• INVENTORY_STATUS_FAIL

Throws:

InventoryException - if there was a problem during the purchase process.

purchaseOffBackorder

public int purchaseOffBackorder(java.lang.String pId,
                       long pHowMany)
                         throws InventoryException

Description copied from interface: InventoryManager

Actually purchases a product. The backend inventory system should register that a purchase has been made. If the purchase succeeds, the item's backorderLevel is increased appropriately.

Specified by:

purchaseOffBackorder in interface InventoryManager

Parameters:

pId - the id of the item involved

Returns:

One of the following:

• INVENTORY_STATUS_SUCCEED
• INVENTORY_STATUS_INSUFFICIENT_SUPPLY
• INVENTORY_STATUS_ITEM_NOT_FOUND
• INVENTORY_STATUS_FAIL

Throws:

InventoryException - if there was a problem during the purchase process.

purchaseOffPreorder

public int purchaseOffPreorder(java.lang.String pId,
                      long pHowMany)
                        throws InventoryException

Description copied from interface: InventoryManager

Actually purchases a product. The backend inventory system should register that a purchase has been made. If the purchase succeeds, the item's preorderLevel is increased appropriately.

Specified by:

purchaseOffPreorder in interface InventoryManager

Parameters:

pId - the id of the item involved

Returns:

One of the following:

• INVENTORY_STATUS_SUCCEED
• INVENTORY_STATUS_INSUFFICIENT_SUPPLY
• INVENTORY_STATUS_ITEM_NOT_FOUND
• INVENTORY_STATUS_FAIL

Throws:

InventoryException - if there was a problem during the purchase process.

preorder

public int preorder(java.lang.String pId,
           long pHowMany)
             throws InventoryException

Description copied from interface: InventoryManager

Preorder an item. The usual implication of preordering is that the retailer has never had the item in stock, but promises to have the item soon.

Specified by:

preorder in interface InventoryManager

Parameters:

pId - the id of the item involved

Returns:

One of the following:

• INVENTORY_STATUS_SUCCEED
• INVENTORY_STATUS_INSUFFICIENT_SUPPLY
• INVENTORY_STATUS_ITEM_NOT_FOUND
• INVENTORY_STATUS_FAIL

Throws:

InventoryException - if there was a problem in trying to preorder the item

backorder

public int backorder(java.lang.String pId,
            long pHowMany)
              throws InventoryException

Description copied from interface: InventoryManager

Backorder an item. The usual implication of this is very similar to preorder, except that the store did at one time have this item, it's just out of it now.

Specified by:

backorder in interface InventoryManager

Parameters:

pId - the id of the item involved

Returns:

One of the following:

• INVENTORY_STATUS_SUCCEED
• INVENTORY_STATUS_INSUFFICIENT_SUPPLY
• INVENTORY_STATUS_ITEM_NOT_FOUND
• INVENTORY_STATUS_FAIL

Throws:

InventoryException - if there was a problem with the backordering process.

setStockLevel

public int setStockLevel(java.lang.String pId,
                long pNumber)
                  throws InventoryException

Description copied from interface: InventoryManager

Set an item's stock level to the specified number.

Specified by:

setStockLevel in interface InventoryManager

Parameters:

pId - the id of the item involved

pNumber - the number of the given item to restock

Returns:

One of the following:

• INVENTORY_STATUS_SUCCEED
• INVENTORY_STATUS_ITEM_NOT_FOUND
• INVENTORY_STATUS_FAIL

Throws:

InventoryException - if there was a problem trying to restock

setBackorderLevel

public int setBackorderLevel(java.lang.String pId,
                    long pNumber)
                      throws InventoryException

Description copied from interface: InventoryManager

Set an item's backorder level to the specified number.

Specified by:

setBackorderLevel in interface InventoryManager

Parameters:

pId - the id of the item involved

pNumber - the number of the given item to restock

Returns:

One of the following:

• INVENTORY_STATUS_SUCCEED
• INVENTORY_STATUS_ITEM_NOT_FOUND
• INVENTORY_STATUS_FAIL

Throws:

InventoryException - if there was a problem trying to restock

setPreorderLevel

public int setPreorderLevel(java.lang.String pId,
                   long pNumber)
                     throws InventoryException

Description copied from interface: InventoryManager

Set an item's preorder level to the specified number.

Specified by:

setPreorderLevel in interface InventoryManager

Parameters:

pId - the id of the item involved

pNumber - the number of the given item to restock

Returns:

One of the following:

• INVENTORY_STATUS_SUCCEED
• INVENTORY_STATUS_ITEM_NOT_FOUND
• INVENTORY_STATUS_FAIL

Throws:

InventoryException - if there was a problem trying to restock

increaseStockLevel

public int increaseStockLevel(java.lang.String pId,
                     long pNumber)
                       throws InventoryException

Description copied from interface: InventoryManager

Increase an item's stock level by the specified number.

Specified by:

increaseStockLevel in interface InventoryManager

Parameters:

pId - the id of the item involved

pNumber - the number of items to add to the current stock level

Returns:

One of the following:

• INVENTORY_STATUS_SUCCEED
• INVENTORY_STATUS_ITEM_NOT_FOUND
• INVENTORY_STATUS_FAIL

Throws:

InventoryException - if there was a problem trying to restock

decreaseStockLevel

public int decreaseStockLevel(java.lang.String pId,
                     long pNumber)
                       throws InventoryException

Description copied from interface: InventoryManager

Decrease an item's stock level by the specified amount. This method is to be used for inventory adjustments, not for purchases. For purchases, use the purchase(String pId, long pHowMany) method.

Specified by:

decreaseStockLevel in interface InventoryManager

Parameters:

pId - the id of the item involved

pNumber - the number of items to decrease from the current stock level

Returns:

One of the following:

• INVENTORY_STATUS_SUCCEED
• INVENTORY_STATUS_INSUFFICIENT_SUPPLY
• INVENTORY_STATUS_ITEM_NOT_FOUND
• INVENTORY_STATUS_FAIL

Throws:

InventoryException - if there was a problem trying to restock

increaseBackorderLevel

public int increaseBackorderLevel(java.lang.String pId,
                         long pNumber)
                           throws InventoryException

Description copied from interface: InventoryManager

Increase an item's backorder level by the specified number.

Specified by:

increaseBackorderLevel in interface InventoryManager

Parameters:

pId - the id of the item involved

pNumber - the number of items to add to the current stock level

Returns:

One of the following:

• INVENTORY_STATUS_SUCCEED
• INVENTORY_STATUS_ITEM_NOT_FOUND
• INVENTORY_STATUS_FAIL

Throws:

InventoryException - if there was a problem trying to restock

decreaseBackorderLevel

public int decreaseBackorderLevel(java.lang.String pId,
                         long pNumber)
                           throws InventoryException

Description copied from interface: InventoryManager

Decrease an item's backorder level by the specified amount.

Specified by:

decreaseBackorderLevel in interface InventoryManager

Parameters:

pId - the id of the item involved

pNumber - the number of items to decrease from the current stock level

Returns:

One of the following:

• INVENTORY_STATUS_SUCCEED
• INVENTORY_STATUS_INSUFFICIENT_SUPPLY
• INVENTORY_STATUS_ITEM_NOT_FOUND
• INVENTORY_STATUS_FAIL

Throws:

InventoryException - if there was a problem trying to restock

increasePreorderLevel

public int increasePreorderLevel(java.lang.String pId,
                        long pNumber)
                          throws InventoryException

Description copied from interface: InventoryManager

Increase an item's preorder level by the specified number.

Specified by:

increasePreorderLevel in interface InventoryManager

Parameters:

pId - the id of the item involved

pNumber - the number of items to add to the current stock level

Returns:

One of the following:

• INVENTORY_STATUS_SUCCEED
• INVENTORY_STATUS_ITEM_NOT_FOUND
• INVENTORY_STATUS_FAIL

Throws:

InventoryException - if there was a problem trying to restock

decreasePreorderLevel

public int decreasePreorderLevel(java.lang.String pId,
                        long pNumber)
                          throws InventoryException

Description copied from interface: InventoryManager

Decrease an item's preorder level by the specified amount.

Specified by:

decreasePreorderLevel in interface InventoryManager

Parameters:

pId - the id of the item involved

pNumber - the number of items to decrease from the current stock level

Returns:

One of the following:

• INVENTORY_STATUS_SUCCEED
• INVENTORY_STATUS_INSUFFICIENT_SUPPLY
• INVENTORY_STATUS_ITEM_NOT_FOUND
• INVENTORY_STATUS_FAIL

Throws:

InventoryException - if there was a problem trying to restock

setStockThreshold

public int setStockThreshold(java.lang.String pId,
                    long pNumber)
                      throws InventoryException

Description copied from interface: InventoryManager

Set an item's stock level threshold.

Specified by:

setStockThreshold in interface InventoryManager

Parameters:

pId - the id of the item involved

pNumber - the number of the given item to restock

Returns:

One of the following:

• INVENTORY_STATUS_SUCCEED
• INVENTORY_STATUS_ITEM_NOT_FOUND
• INVENTORY_STATUS_FAIL

Throws:

InventoryException - if there was a problem trying to restock

setBackorderThreshold

public int setBackorderThreshold(java.lang.String pId,
                        long pNumber)
                          throws InventoryException

Description copied from interface: InventoryManager

Set an item's backorder level threshold.

Specified by:

setBackorderThreshold in interface InventoryManager

Parameters:

pId - the id of the item involved

pNumber - the number of the given item to restock

Returns:

One of the following:

• INVENTORY_STATUS_SUCCEED
• INVENTORY_STATUS_ITEM_NOT_FOUND
• INVENTORY_STATUS_FAIL

Throws:

InventoryException - if there was a problem trying to restock

setPreorderThreshold

public int setPreorderThreshold(java.lang.String pId,
                       long pNumber)
                         throws InventoryException

Description copied from interface: InventoryManager

Set an item's preorder level threshold.

Specified by:

setPreorderThreshold in interface InventoryManager

Parameters:

pId - the id of the item involved

pNumber - the number of the given item to restock

Returns:

One of the following:

• INVENTORY_STATUS_SUCCEED
• INVENTORY_STATUS_ITEM_NOT_FOUND
• INVENTORY_STATUS_FAIL

Throws:

InventoryException - if there was a problem trying to restock

setAvailabilityStatus

public int setAvailabilityStatus(java.lang.String pId,
                        int pStatus)
                          throws InventoryException

Description copied from interface: InventoryManager

Set an item's availability status.

Specified by:

setAvailabilityStatus in interface InventoryManager

Parameters:

pId - the id of the item involved

pStatus - the new status (one of AVAILABILITY_STATUS_IN_STOCK, AVAILABILITY_STATUS_BACKORDERABLE, AVAILABILITY_STATUS_PREORDERABLE, AVAILABILITY_STATUS_OUT_OF_STOCK, AVAILABILITY_STATUS_DISCONTINUED, or AVAILABILITY_STATUS_DERIVED)

Returns:

One of the following:

• INVENTORY_STATUS_SUCCEED
• INVENTORY_STATUS_ITEM_NOT_FOUND
• INVENTORY_STATUS_FAIL

Throws:

InventoryException

setAvailabilityDate

public int setAvailabilityDate(java.lang.String pId,
                      java.util.Date pDate)
                        throws InventoryException

Description copied from interface: InventoryManager

Set an item's availability date.

Specified by:

setAvailabilityDate in interface InventoryManager

Parameters:

pId - the id of the item involved

pDate - The new availability date for the item.

Returns:

One of the following:

• INVENTORY_STATUS_SUCCEED
• INVENTORY_STATUS_ITEM_NOT_FOUND
• INVENTORY_STATUS_FAIL

Throws:

InventoryException

queryAvailabilityStatus

public int queryAvailabilityStatus(java.lang.String pId)
                            throws InventoryException

Description copied from interface: InventoryManager

Return the availability status of a given item. If an item has a status of DERIVED, then the return value is calculated. Otherwise the existing status is returned.

Specified by:

queryAvailabilityStatus in interface InventoryManager

Parameters:

pId - The id of the item involved.

Returns:

One of the following states:

• AVAILABILITY_STATUS_IN_STOCK
• AVAILABILITY_STATUS_OUT_OF_STOCK
• AVAILABILITY_STATUS_PREORDERABLE
• AVAILABILITY_STATUS_BACKORDERABLE
• AVAILABILITY_STATUS_DISCONTINUED

Throws:

InventoryException - if there was a problem determining the status of the item

queryStockLevel

public long queryStockLevel(java.lang.String pId)
                     throws InventoryException

Description copied from interface: InventoryManager

Return how many of a given item are in the system.

Specified by:

queryStockLevel in interface InventoryManager

Returns:

how many items, with the given id, are available for purchase

Throws:

InventoryException - if there was a problem determining the number

queryBackorderLevel

public long queryBackorderLevel(java.lang.String pId)
                         throws InventoryException

Description copied from interface: InventoryManager

Return how many of a given item can be backorder.

Specified by:

queryBackorderLevel in interface InventoryManager

Returns:

how many items, with the given id, are available for purchase

Throws:

InventoryException - if there was a problem determining the number

queryPreorderLevel

public long queryPreorderLevel(java.lang.String pId)
                        throws InventoryException

Description copied from interface: InventoryManager

Return how many of a given item can be preorder.

Specified by:

queryPreorderLevel in interface InventoryManager

Returns:

how many items, with the given id, are available for purchase

Throws:

InventoryException - if there was a problem determining the number

queryPreorderThreshold

public long queryPreorderThreshold(java.lang.String pId)
                            throws InventoryException

Description copied from interface: InventoryManager

Return the threshold associated with preorderLevel

Specified by:

queryPreorderThreshold in interface InventoryManager

Returns:

how many items, with the given id, are available for purchase

Throws:

InventoryException - if there was a problem determining the number

queryAvailabilityDate

public java.util.Date queryAvailabilityDate(java.lang.String pId)
                                     throws InventoryException

Description copied from interface: InventoryManager

Return the availability date of an item.

Specified by:

queryAvailabilityDate in interface InventoryManager

Returns:

the date that the item will be available for puchase if the item's availability status is not AVAILABILITY_STATUS_IN_STOCK. If the item's availability status is AVAILABILITY_STATUS_IN_STOCK, then we return null.

Throws:

InventoryException - if there was a problem determining the date

queryStockThreshold

public long queryStockThreshold(java.lang.String pId)
                         throws InventoryException

Description copied from interface: InventoryManager

Return the threshold associated with stockLevel.

Specified by:

queryStockThreshold in interface InventoryManager

Returns:

how many items, with the given id, are available for purchase

Throws:

InventoryException - if there was a problem determining the number

queryBackorderThreshold

public long queryBackorderThreshold(java.lang.String pId)
                             throws InventoryException

Description copied from interface: InventoryManager

Return the threshold associated with backorderLevel

Specified by:

queryBackorderThreshold in interface InventoryManager

Returns:

how many items, with the given id, are available for purchase

Throws:

InventoryException - if there was a problem determining the number

inventoryWasUpdated

public int inventoryWasUpdated(java.util.List pItemIds)
                        throws InventoryException

Description copied from interface: InventoryManager

Informs the inventory manager that the given ids are now available. Some implementations of the InventoryManager may send a message informing other systems that some items that were previously unavailable are now available. No changes are made to the inventory.

Specified by:

inventoryWasUpdated in interface InventoryManager

Parameters:

pItemIds - The items with recently added inventory

Throws:

InventoryException

acquireInventoryLocks

public void acquireInventoryLocks(java.util.List pItemIds)
                           throws InventoryException

Description copied from interface: InventoryManager

Acquires locks for the inventory items that apply to the given ids.

Specified by:

acquireInventoryLocks in interface InventoryManager

Throws:

InventoryException

releaseInventoryLocks

public void releaseInventoryLocks(java.util.List pItemIds)
                           throws InventoryException

Description copied from interface: InventoryManager

Release locks for the inventory items that apply to the given ids.

Specified by:

releaseInventoryLocks in interface InventoryManager

Throws:

InventoryException