The Inventory System consists of implementations of an Inventory Manager interface. The interface consists of the following methods. Refer to the ATG API Reference for more information on these methods.

Method

Action Performed

purchase

Decreases the inventory (stocklevel) of the item. Returns unsuccessfully if inventory is not available. This method is required by any implementation of the inventory system.

purchaseOffBackorder

Does the same thing as purchase and increases the backorderLevel.

purchaseOffPreorder

Does the same thing as purchase and increases the preorderLevel.

preorder

Decreases the preorderLevel of the item. Returns unsuccessfully if the preorderLevel is lower than the quantity being preordered.

backorder

Decreases the backorderLevel of the item. Returns unsuccessfully if the backorderLevel is lower than the quantity being backordered.

setStocklevel

Sets the stocklevel to a fixed number.

setBackorderLevel

Sets the backorderLevel to a fixed number.

setPreorderLevel

Sets the preorderLevel to a fixed number.

increaseStocklevel

Increases the stocklevel of an item by some quantity. This is used if an order is cancelled after the item has already been purchased or the administrator can call it.

increaseBackorderLevel

Increases the backorderLevel of an item by some quantity. This is used if an order is cancelled after the item has already been backorded or the administrator can call it.

increasePreorderLevel

Increases the preorderLevel of an item. This is used if an order is cancelled after the item has already been preordered or the administrator can call it.

decreaseStocklevel

Decreases the stocklevel of an item. This should not be used in place of purchase. An administrator usually calls it.

decreaseBackorderLevel

Decreases the backorderLevel of an item. This should not be used in place of backorder. An administrator usually calls it.

decreasePreorderLevel

Decreases the preorderLevel of an item. This should not be used in place of preorder. An administrator usually calls it.

setStockThreshold

Sets the threshold associated with stocklevel (stockThreshold) to a fixed number.

setBackorderThreshold

Sets the threshold associated with backorderLevel (backorderThreshold) to a fixed number.

setPreorderThreshold

Sets the threshold associated with preorderLevel (preorderThreshold) to a fixed number.

setAvailabilityStatus

Sets the availability status.

setAvailabilityDate

Sets the date at which the item will become available.

queryAvailabilityStatus

Determines whether an item is in stock, out of stock, backorderable, or preorderable. Used when determining which method to call: purchase, backorder, or preorder.

queryStocklevel

Returns the number of items available for purchase (stocklevel).

queryBackorderLevel

Returns the number of items available for backorder (backorderLevel).

queryPreorderLevel

Returns the number of items available for preorder (preorderLevel).

queryStockThreshold

Returns the stockThreshold.

queryBackorderThreshold

Returns the backorderThreshold.

queryPreorderThreshold

Returns the preorderThreshold.

queryAvailabilityDate

Returns the date when this item will become available.

inventoryWasUpdated

This method is called when a set of items is added to inventory. It is a convenient way of notifying interested systems of a large update. Does not change the state of the inventory.

 
loading table of contents...