atg.commerce.inventory

Class LocalizingLocationInventoryManager

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.commerce.messaging.SourceSinkTemplate

atg.commerce.inventory.LocalizingLocationInventoryManager

All Implemented Interfaces:

InventoryManager, LocationInventoryManager, atg.core.logging.Logging, atg.core.logging.TraceLogging, MessageSink, MessageSource, atg.naming.AbsoluteNameable, NameContextBindingListener, NameContextElement, atg.naming.NameContextParentable, NameResolver, AdminableService, atg.nucleus.Configured, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, VariableArgumentApplicationLogging, ComponentNameResolver, Service, ServiceListener, java.util.EventListener

public class LocalizingLocationInventoryManager
extends SourceSinkTemplate
implements LocationInventoryManager

This class implements LocationInventoryManager for the purpose of localizing inventory. It provides capability to call a particular inventory manager, based on a locale key while also supporting location based inventory calls.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION

Fields inherited from class atg.nucleus.GenericService

SERVICE_INFO_KEY

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

Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging

DEFAULT_LOG_TRACE_STATUS

Fields inherited from interface atg.nucleus.logging.ApplicationLogging

DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS

Constructor Summary

Constructors

Constructor and Description
LocalizingLocationInventoryManager()

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.
void	acquireInventoryLocks(java.util.List pItemIds, java.lang.String pLocationId, java.lang.String pLocaleKey)
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	backorder(java.lang.String pId, long pHowMany, java.lang.String pLocationId, java.lang.String pLocaleKey)
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	decreaseBackorderLevel(java.lang.String pId, long pNumber, java.lang.String pLocationId, java.lang.String pLocaleKey)
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	decreasePreorderLevel(java.lang.String pId, long pNumber, java.lang.String pLocationId, java.lang.String pLocaleKey)
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.
int	decreaseStockLevel(java.lang.String pId, long pNumber, java.lang.String pLocationId, java.lang.String pLocaleKey)
LocationInventoryManager	getDefaultInventoryManager() Returns property DefaultInventoryManager
java.lang.String	getDefaultLocaleKey()
LocationInventoryManager	getInventoryManager(java.lang.String pLocaleKey) Returns an InventoryManager, localized if the localeKey parameter was passed as a parameter to the servlet bean and a map of InventoryManagers has been defined.
ServiceMap	getInventoryManagers() Returns property InventoryManagers
java.lang.String	getInventoryName() The displayable name of this inventory manager.
java.lang.String	getInventoryName(java.lang.String pLocaleKey)
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	increaseBackorderLevel(java.lang.String pId, long pNumber, java.lang.String pLocationId, java.lang.String pLocaleKey)
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	increasePreorderLevel(java.lang.String pId, long pNumber, java.lang.String pLocationId, java.lang.String pLocaleKey)
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	increaseStockLevel(java.lang.String pId, long pNumber, java.lang.String pLocationId, java.lang.String pLocaleKey)
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	inventoryWasUpdated(java.util.List pItemIds, java.lang.String pLocationId, java.lang.String pLocaleKey)
boolean	isUseDefaultInventoryManager() Returns property useDefaultInventoryManager
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	preorder(java.lang.String pId, long pHowMany, java.lang.String pLocationId, java.lang.String pLocaleKey)
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	purchase(java.lang.String pId, long pHowMany, java.lang.String pLocationId, java.lang.String pLocaleKey)
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	purchaseOffBackorder(java.lang.String pId, long pHowMany, java.lang.String pLocationId, java.lang.String pLocaleKey)
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.
int	purchaseOffPreorder(java.lang.String pId, long pHowMany, java.lang.String pLocationId, java.lang.String pLocaleKey)
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.
java.util.Date	queryAvailabilityDate(java.lang.String pId, java.lang.String pLocationId, java.lang.String pLocaleKey)
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.
int	queryAvailabilityStatus(java.lang.String pId, java.lang.String pLocationId, java.lang.String pLocaleKey)
AvailableToPromise	queryAvailableToPromise(java.lang.String pItemId, java.lang.String pLocationId) Returns Available To Promise information for a given id and location
AvailableToPromise	queryAvailableToPromise(java.lang.String pItemId, java.lang.String pLocationId, java.lang.String pLocaleKey)
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 can be backorder.
long	queryBackorderLevel(java.lang.String pId, java.lang.String pLocationId, java.lang.String pLocaleKey)
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
long	queryBackorderThreshold(java.lang.String pId, java.lang.String pLocationId, java.lang.String pLocaleKey)
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.util.Collection<java.lang.String> pLocationIds, java.lang.String pLocaleKey)
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.util.Collection<java.lang.String> pItemIds, java.lang.String pLocationId, java.lang.String pLocaleKey)
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
java.util.Collection<InventoryInfo>	queryInventoryInformation(java.lang.String pId, java.util.Collection<java.lang.String> pLocationIds, java.lang.String pLocaleKey)
InventoryInfo	queryInventoryInformation(java.lang.String pId, java.lang.String pLocationId) Returns an InventoryInfo object for the given id and location
InventoryInfo	queryInventoryInformation(java.lang.String pId, java.lang.String pLocationId, java.lang.String pLocaleKey)
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 can be preorder.
long	queryPreorderLevel(java.lang.String pId, java.lang.String pLocationId, java.lang.String pLocaleKey)
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	queryPreorderThreshold(java.lang.String pId, java.lang.String pLocationId, java.lang.String pLocaleKey)
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	queryStockLevel(java.lang.String pId, java.lang.String pLocationId, java.lang.String pLocaleKey)
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.
long	queryStockThreshold(java.lang.String pId, java.lang.String pLocationId, java.lang.String pLocaleKey)
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.
void	releaseInventoryLocks(java.util.List pItemIds, java.lang.String pLocationId, java.lang.String pLocaleKey)
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	setAvailabilityDate(java.lang.String pId, java.util.Date pDate, java.lang.String pLocationId, java.lang.String pLocaleKey)
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	setAvailabilityStatus(java.lang.String pId, int pStatus, java.lang.String pLocationId, java.lang.String pLocaleKey)
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	setBackorderLevel(java.lang.String pId, long pNumber, java.lang.String pLocationId, java.lang.String pLocaleKey)
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.
int	setBackorderThreshold(java.lang.String pId, long pNumber, java.lang.String pLocationId, java.lang.String pLocaleKey)
void	setDefaultInventoryManager(LocationInventoryManager pDefaultInventoryManager) Sets property InventoryManager
void	setDefaultLocaleKey(java.lang.String pDefaultLocaleKey) Sets property mDefaultLocalKey
void	setInventoryManagers(ServiceMap pInventoryManagers) Sets property InventoryManagers
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	setPreorderLevel(java.lang.String pId, long pNumber, java.lang.String pLocationId, java.lang.String pLocaleKey)
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	setPreorderThreshold(java.lang.String pId, long pNumber, java.lang.String pLocationId, java.lang.String pLocaleKey)
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	setStockLevel(java.lang.String pId, long pNumber, java.lang.String pLocationId, java.lang.String pLocaleKey)
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.
int	setStockThreshold(java.lang.String pId, long pNumber, java.lang.String pLocationId, java.lang.String pLocaleKey)
void	setUseDefaultInventoryManager(boolean pUseDefaultInventoryManager) Sets property useDefaultInventoryManager.

Methods inherited from class atg.commerce.messaging.SourceSinkTemplate

getDelayOnSendRetry, getMessageSourceContext, getMessageSourceName, getTransactionManager, isAllowMessageSending, receiveMessage, sendCommerceMessage, sendObjectMessage, setAllowMessageSending, setDelayOnSendRetry, setMessageSourceContext, setMessageSourceName, setTransactionManager, startMessageSource, stopMessageSource

Methods inherited from class atg.nucleus.GenericService

addLogListener, createAdminServlet, doStartService, doStopService, getAbsoluteName, getAdminServlet, getAdminServletOutputStreamEncoding, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isAdminServletUseServletOutputStream, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, reResolveThis, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setAdminServletOutputStreamEncoding, setAdminServletUseServletOutputStream, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService

Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning

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

Constructor Detail

LocalizingLocationInventoryManager

public LocalizingLocationInventoryManager()

Method Detail

setDefaultLocaleKey

public void setDefaultLocaleKey(java.lang.String pDefaultLocaleKey)

Sets property mDefaultLocalKey

getDefaultLocaleKey

public java.lang.String getDefaultLocaleKey()

setDefaultInventoryManager

public void setDefaultInventoryManager(LocationInventoryManager pDefaultInventoryManager)

Sets property InventoryManager

getDefaultInventoryManager

public LocationInventoryManager getDefaultInventoryManager()

Returns property DefaultInventoryManager

setInventoryManagers

public void setInventoryManagers(ServiceMap pInventoryManagers)

Sets property InventoryManagers

getInventoryManagers

public ServiceMap getInventoryManagers()

Returns property InventoryManagers

setUseDefaultInventoryManager

public void setUseDefaultInventoryManager(boolean pUseDefaultInventoryManager)

Sets property useDefaultInventoryManager. Set it to true if you want the default inventory manager to be used in case the requested inventory manager is unavailable. If set to false, then requesting an unavilable alternate inventory manager will result in an error.

isUseDefaultInventoryManager

public boolean isUseDefaultInventoryManager()

Returns property useDefaultInventoryManager

getInventoryManager

public LocationInventoryManager getInventoryManager(java.lang.String pLocaleKey)

Returns an InventoryManager, localized if the localeKey parameter was passed as a parameter to the servlet bean and a map of InventoryManagers has been defined.

getInventoryName

public java.lang.String getInventoryName(java.lang.String pLocaleKey)

purchase

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

Parameters:

pLocaleKey - the locale key

Throws:

InventoryException

See Also:

LocationInventoryManager.purchase(String, long, String)

purchaseOffBackorder

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

Parameters:

pLocaleKey - the locale key

Throws:

InventoryException

See Also:

LocationInventoryManager.purchaseOffBackorder(String, long, String)

purchaseOffPreorder

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

Parameters:

pLocaleKey - the locale key

Throws:

InventoryException

See Also:

LocationInventoryManager.purchaseOffPreorder(String, long, String)

preorder

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

Parameters:

pLocaleKey - the locale key

Throws:

InventoryException

See Also:

LocationInventoryManager.preorder(String, long, String)

backorder

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

Parameters:

pLocaleKey - the locale key

Throws:

InventoryException

See Also:

LocationInventoryManager.backorder(String, long, String)

setStockLevel

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

Parameters:

pLocaleKey - the locale key

Throws:

InventoryException

See Also:

LocationInventoryManager.setStockLevel(String, long, String)

setBackorderLevel

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

Parameters:

pLocaleKey - the locale key

Throws:

InventoryException

See Also:

LocationInventoryManager.setBackorderLevel(String, long, String)

setPreorderLevel

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

Parameters:

pLocaleKey - the locale key

Throws:

InventoryException

See Also:

LocationInventoryManager.setPreorderLevel(String, long, String)

increaseStockLevel

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

Parameters:

pLocaleKey - the locale key

Throws:

InventoryException

See Also:

LocationInventoryManager.increaseStockLevel(String, long, String)

decreaseStockLevel

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

Parameters:

pLocaleKey - the locale key

Throws:

InventoryException

See Also:

LocationInventoryManager.decreaseStockLevel(String, long, String)

increaseBackorderLevel

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

Parameters:

pLocaleKey - the locale key

Throws:

InventoryException

See Also:

LocationInventoryManager.increaseBackorderLevel(String, long, String)

decreaseBackorderLevel

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

Parameters:

pLocaleKey - the locale key

Throws:

InventoryException

See Also:

LocationInventoryManager.decreaseBackorderLevel(String, long, String)

increasePreorderLevel

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

Parameters:

pLocaleKey - the locale key

Throws:

InventoryException

See Also:

LocationInventoryManager.increasePreorderLevel(String, long, String)

decreasePreorderLevel

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

Parameters:

pLocaleKey - the locale key

Throws:

InventoryException

See Also:

LocationInventoryManager.decreasePreorderLevel(String, long, String)

setStockThreshold

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

Parameters:

pLocaleKey - the locale key

Throws:

InventoryException

See Also:

LocationInventoryManager.setStockThreshold(String, long, String)

setBackorderThreshold

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

Parameters:

pLocaleKey - the locale key

Throws:

InventoryException

See Also:

LocationInventoryManager.setBackorderThreshold(String, long, String)

setPreorderThreshold

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

Parameters:

pLocaleKey - the locale key

Throws:

InventoryException

See Also:

LocationInventoryManager.setPreorderThreshold(String, long, String)

setAvailabilityStatus

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

Parameters:

pLocaleKey - the locale key

Throws:

InventoryException

See Also:

LocationInventoryManager.setAvailabilityStatus(String, int, String)

setAvailabilityDate

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

Parameters:

pLocaleKey - the locale key

Throws:

InventoryException

See Also:

LocationInventoryManager.setAvailabilityDate(String, Date, String)

queryAvailabilityStatus

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

Parameters:

pLocaleKey - the locale key

Throws:

InventoryException

See Also:

LocationInventoryManager.queryAvailabilityStatus(String, String)

queryStockLevel

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

Parameters:

pLocaleKey - the locale key

Throws:

InventoryException

See Also:

LocationInventoryManager.queryStockLevel(String, String)

queryBackorderLevel

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

Parameters:

pLocaleKey - the locale key

Throws:

InventoryException

See Also:

LocationInventoryManager.queryBackorderLevel(String, String)

queryPreorderLevel

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

Parameters:

pLocaleKey - the locale key

Throws:

InventoryException

See Also:

LocationInventoryManager#queryPreOrderLevel(String, String)

queryStockThreshold

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

Parameters:

pLocaleKey - the locale key

Throws:

InventoryException

See Also:

LocationInventoryManager.queryStockThreshold(String, String)

queryBackorderThreshold

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

Parameters:

pLocaleKey - the locale key

Throws:

InventoryException

See Also:

LocationInventoryManager.queryBackorderThreshold(String, String)

queryPreorderThreshold

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

Parameters:

pLocaleKey - the locale key

Throws:

InventoryException

See Also:

LocationInventoryManager.queryPreorderThreshold(String, String)

queryAvailabilityDate

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

Parameters:

pLocaleKey - the locale key

Throws:

InventoryException

See Also:

LocationInventoryManager.queryAvailabilityDate(String, String)

inventoryWasUpdated

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

Parameters:

pLocaleKey - the locale key

Throws:

InventoryException

See Also:

LocationInventoryManager#inventoryWasUpdated(String, String)

acquireInventoryLocks

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

Parameters:

pLocaleKey - the locale key

Throws:

InventoryException

See Also:

LocationInventoryManager#acquireInventoryLocks(String, String)

releaseInventoryLocks

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

Parameters:

pLocaleKey - the locale key

Throws:

InventoryException

See Also:

LocationInventoryManager#releaseInventoryLocks(String, String)

queryInventoryInformation

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

Parameters:

pLocaleKey - the locale key

Throws:

InventoryException

See Also:

LocationInventoryManager.queryInventoryInformation(String, String)

queryInventoryInformation

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

Parameters:

pLocaleKey - the locale key

Throws:

InventoryException

See Also:

LocationInventoryManager#queryInventoryInformation(Collection, String)

queryInventoryInformation

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

Parameters:

pLocaleKey - the locale key

Throws:

InventoryException

See Also:

LocationInventoryManager.queryInventoryInformation(String, Collection)

queryInventoryInformation

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

Parameters:

pLocaleKey - the locale key

Throws:

InventoryException

See Also:

LocationInventoryManager.queryInventoryInformation(Collection, Collection)

queryAvailableToPromise

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

Parameters:

pLocaleKey - the locale key

Throws:

InventoryException

See Also:

LocationInventoryManager.queryAvailableToPromise(String, String)

getInventoryName

public java.lang.String getInventoryName()

Description copied from interface: InventoryManager

The displayable name of this inventory manager.

Specified by:

getInventoryName in interface InventoryManager

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

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

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

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

purchase

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

Description copied from interface: LocationInventoryManager

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:

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,
                       java.lang.String pLocationId)
                         throws InventoryException

Description copied from interface: LocationInventoryManager

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:

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,
                      java.lang.String pLocationId)
                        throws InventoryException

Description copied from interface: LocationInventoryManager

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:

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,
           java.lang.String pLocationId)
             throws InventoryException

Description copied from interface: LocationInventoryManager

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:

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,
            java.lang.String pLocationId)
              throws InventoryException

Description copied from interface: LocationInventoryManager

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:

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,
                java.lang.String pLocationId)
                  throws InventoryException

Description copied from interface: LocationInventoryManager

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:

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,
                    java.lang.String pLocationId)
                      throws InventoryException

Description copied from interface: LocationInventoryManager

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:

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,
                   java.lang.String pLocationId)
                     throws InventoryException

Description copied from interface: LocationInventoryManager

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:

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,
                     java.lang.String pLocationId)
                       throws InventoryException

Description copied from interface: LocationInventoryManager

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:

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,
                     java.lang.String pLocationId)
                       throws InventoryException

Description copied from interface: LocationInventoryManager

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:

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,
                         java.lang.String pLocationId)
                           throws InventoryException

Description copied from interface: LocationInventoryManager

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:

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,
                         java.lang.String pLocationId)
                           throws InventoryException

Description copied from interface: LocationInventoryManager

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:

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,
                        java.lang.String pLocationId)
                          throws InventoryException

Description copied from interface: LocationInventoryManager

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:

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,
                        java.lang.String pLocationId)
                          throws InventoryException

Description copied from interface: LocationInventoryManager

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:

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,
                    java.lang.String pLocationId)
                      throws InventoryException

Description copied from interface: LocationInventoryManager

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:

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,
                        java.lang.String pLocationId)
                          throws InventoryException

Description copied from interface: LocationInventoryManager

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:

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,
                       java.lang.String pLocationId)
                         throws InventoryException

Description copied from interface: LocationInventoryManager

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:

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,
                        java.lang.String pLocationId)
                          throws InventoryException

Description copied from interface: LocationInventoryManager

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:

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,
                      java.lang.String pLocationId)
                        throws InventoryException

Description copied from interface: LocationInventoryManager

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:

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,
                          java.lang.String pLocationId)
                            throws InventoryException

Description copied from interface: LocationInventoryManager

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 LocationInventoryManager

Parameters:

pId - The id of the item involved.

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

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,
                   java.lang.String pLocationId)
                     throws InventoryException

Description copied from interface: LocationInventoryManager

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

queryBackorderLevel

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

Description copied from interface: LocationInventoryManager

Return how many of a given item can be 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 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

Description copied from interface: LocationInventoryManager

Return how many of a given item can be 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 purchase

Throws:

InventoryException - if there was a problem determining the number

queryStockThreshold

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

Description copied from interface: LocationInventoryManager

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

Description copied from interface: LocationInventoryManager

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

Description copied from interface: LocationInventoryManager

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

queryAvailabilityDate

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

Description copied from interface: LocationInventoryManager

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

Description copied from interface: LocationInventoryManager

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

Description copied from interface: LocationInventoryManager

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

Description copied from interface: LocationInventoryManager

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

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

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