atg.commerce.inventory

Interface LocationInventoryManager

All Superinterfaces:

InventoryManager

All Known Implementing Classes:

AbstractInventoryManagerImpl, CachingInventoryManager, LocalizingLocationInventoryManager, NoInventoryManager, RepositoryInventoryManager

public interface LocationInventoryManager
extends InventoryManager

This interface describes an inventory manager that handles inventory from multiple. locations. It provides capability to interact with a backend inventory system in three types of ways: -Inspect the inventory system -Alter the state of the inventory system -Inspect how users have been using the system

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CLASS_VERSION Class version string

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

Method Summary

Modifier and Type	Method and Description
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, double pQuantity, java.lang.String pLocationId) Backorder an item.
int	backorder(java.lang.String pId, long pQuantity, java.lang.String pLocationId) Backorder an item.
int	decreaseBackorderLevel(java.lang.String pId, double 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) Decrease an item's backorder level by the specified amount.
int	decreasePreorderLevel(java.lang.String pId, double 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) Decrease an item's preorder level by the specified amount.
int	decreaseStockLevel(java.lang.String pId, double 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) Decrease an item's stock level by the specified amount.
int	increaseBackorderLevel(java.lang.String pId, double 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) Increase an item's backorder level by the specified number.
int	increasePreorderLevel(java.lang.String pId, double 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) Increase an item's preorder level by the specified number.
int	increaseStockLevel(java.lang.String pId, double 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) Increase an item's stock level by the specified number.
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, double pQuantity, java.lang.String pLocationId) Preorder an item.
int	preorder(java.lang.String pId, long pQuantity, java.lang.String pLocationId) Preorder an item.
int	purchase(java.lang.String pId, double pQuantity, java.lang.String pLocationId) Actually purchases a product.
int	purchase(java.lang.String pId, long pQuantity, java.lang.String pLocationId) Actually purchases a product.
int	purchaseOffBackorder(java.lang.String pId, double pQuantity, java.lang.String pLocationId) Actually purchases a product.
int	purchaseOffBackorder(java.lang.String pId, long pQuantity, java.lang.String pLocationId) Actually purchases a product.
int	purchaseOffPreorder(java.lang.String pId, double pQuantity, java.lang.String pLocationId) Actually purchases a product.
int	purchaseOffPreorder(java.lang.String pId, long pQuantity, java.lang.String pLocationId) Actually purchases a product.
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, 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, java.lang.String pLocationId) Return how many of a given item can be backorder.
double	queryBackorderLevelWithFraction(java.lang.String pId, java.lang.String pLocationId) Return how many of a given item can be backorder.
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, java.lang.String pLocationId) Return how many of a given item can be preorder.
double	queryPreorderLevelWithFraction(java.lang.String pId, java.lang.String pLocationId) Return how many of a given item can be preorder.
long	queryPreorderThreshold(java.lang.String pId, java.lang.String pLocationId) Return the threshold associated with preorderLevel
long	queryStockLevel(java.lang.String pId, java.lang.String pLocationId) Return how many of a given item are in the system.
double	queryStockLevelWithFraction(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, java.lang.String pLocationId) Return the threshold associated with stockLevel.
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, java.lang.String pLocationId) Set an item's availability date.
int	setAvailabilityStatus(java.lang.String pId, int pStatus, java.lang.String pLocationId) Set an item's availability status.
int	setBackorderLevel(java.lang.String pId, double 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) Set an item's backorder level to the specified number.
int	setBackorderThreshold(java.lang.String pId, long pNumber, java.lang.String pLocationId) Set an item's backorder level threshold.
int	setPreorderLevel(java.lang.String pId, double 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) Set an item's preorder level to the specified number.
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, double 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) Set an item's stock level to the specified number.
int	setStockThreshold(java.lang.String pId, long pNumber, java.lang.String pLocationId) Set an item's stock level threshold.

Methods inherited from interface atg.commerce.inventory.InventoryManager

acquireInventoryLocks, backorder, backorder, decreaseBackorderLevel, decreaseBackorderLevel, decreasePreorderLevel, decreasePreorderLevel, decreaseStockLevel, decreaseStockLevel, getInventoryName, increaseBackorderLevel, increaseBackorderLevel, increasePreorderLevel, increasePreorderLevel, increaseStockLevel, increaseStockLevel, inventoryWasUpdated, preorder, preorder, purchase, purchase, purchaseOffBackorder, purchaseOffBackorder, purchaseOffPreorder, purchaseOffPreorder, queryAvailabilityDate, queryAvailabilityStatus, queryBackorderLevel, queryBackorderLevelWithFraction, queryBackorderThreshold, queryPreorderLevel, queryPreorderLevelWithFraction, queryPreorderThreshold, queryStockLevel, queryStockLevelWithFraction, queryStockThreshold, releaseInventoryLocks, setAvailabilityDate, setAvailabilityStatus, setBackorderLevel, setBackorderLevel, setBackorderThreshold, setPreorderLevel, setPreorderLevel, setPreorderThreshold, setStockLevel, setStockLevel, setStockThreshold

Field Detail

CLASS_VERSION

static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

Method Detail

purchase

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

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

Parameters:

pId - the id of the item involved

pQuantity - the quantity of product

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.

purchase

int purchase(java.lang.String pId,
             double pQuantity,
             java.lang.String pLocationId)
      throws InventoryException

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

Parameters:

pId - the id of the item involved

pQuantity - the quantity of product

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

int purchaseOffBackorder(java.lang.String pId,
                         long pQuantity,
                         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.

Parameters:

pId - the id of the item involved

pQuantity - the quantity of product

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

int purchaseOffBackorder(java.lang.String pId,
                         double pQuantity,
                         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.

Parameters:

pId - the id of the item involved

pQuantity - the quantity of product

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

int purchaseOffPreorder(java.lang.String pId,
                        long pQuantity,
                        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.

Parameters:

pId - the id of the item involved

pQuantity - the quantity of product

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

int purchaseOffPreorder(java.lang.String pId,
                        double pQuantity,
                        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.

Parameters:

pId - the id of the item involved

pQuantity - the quantity of product

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

int preorder(java.lang.String pId,
             long pQuantity,
             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.

Parameters:

pId - the id of the item involved

pQuantity - the quantity of product

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

preorder

int preorder(java.lang.String pId,
             double pQuantity,
             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.

Parameters:

pId - the id of the item involved

pQuantity - the quantity of product

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

int backorder(java.lang.String pId,
              long pQuantity,
              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.

Parameters:

pId - the id of the item involved

pQuantity - the quantity of product

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.

backorder

int backorder(java.lang.String pId,
              double pQuantity,
              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.

Parameters:

pId - the id of the item involved

pQuantity - the quantity of product

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

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

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

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

setStockLevel

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

increaseStockLevel

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

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

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

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 pQuantity) method.

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

decreaseStockLevel

int decreaseStockLevel(java.lang.String pId,
                       double 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 pQuantity) method.

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

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

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

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

increaseBackorderLevel

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

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

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

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

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

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

decreaseBackorderLevel

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

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

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

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

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

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

increasePreorderLevel

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

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

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

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

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

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

decreasePreorderLevel

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

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

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

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

Set an item's stock level threshold.

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

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

Set an item's backorder level threshold.

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

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

Set an item's preorder level threshold.

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

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

Set an item's availability status.

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

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

Set an item's availability date.

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

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

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.

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

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

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

Parameters:

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

queryStockLevelWithFraction

double queryStockLevelWithFraction(java.lang.String pId,
                                   java.lang.String pLocationId)
                            throws InventoryException

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

Parameters:

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

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

Return how many of a given item can be backorder.

Parameters:

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

queryBackorderLevelWithFraction

double queryBackorderLevelWithFraction(java.lang.String pId,
                                       java.lang.String pLocationId)
                                throws InventoryException

Return how many of a given item can be backorder.

Parameters:

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

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

Return how many of a given item can be preorder.

Parameters:

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

queryPreorderLevelWithFraction

double queryPreorderLevelWithFraction(java.lang.String pId,
                                      java.lang.String pLocationId)
                               throws InventoryException

Return how many of a given item can be preorder.

Parameters:

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

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

Return the threshold associated with stockLevel.

Parameters:

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

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

Return the threshold associated with backorderLevel

Parameters:

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

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

Return the threshold associated with preorderLevel

Parameters:

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

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

Return the availability date of an item.

Parameters:

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

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. No changes are made to the inventory.

Parameters:

pItemIds - The items with recently added inventory

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

Throws:

InventoryException

acquireInventoryLocks

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

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

Parameters:

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

Throws:

InventoryException

releaseInventoryLocks

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

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

Parameters:

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

Throws:

InventoryException

queryInventoryInformation

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

Returns an InventoryInfo object for the given id and location

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

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

Returns an InventoryInfo object for each id at the given location

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

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

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

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

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

Returns an InventoryInfo object for every id at every location

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

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

Returns Available To Promise information for a given id and location

Parameters:

pItemId - The item to find the ATP information for

pLocationId - The location to find ATP information for.

Returns:

The Availability information

Throws:

InventoryException