org.broadleafcommerce.core.inventory.service

Interface InventoryService

All Known Implementing Classes:

InventoryServiceImpl

public interface InventoryService

This basic inventory service checks and adjusts the current inventory of a sku. All Skus will be considered generally unavailable from an inventory perspective if Sku.isAvaliable() returns false or if Sku.isActive() returns false. Skus with an InventoryType of null or 'ALWAYS_AVAILABLE' will be considered undefined from an inventory perspective, and will generally be considered available. However, a request for available quantities of Skus with a null or 'ALWAYS_AVAILABLE' inventory type will return null (as the sku is available but no inventory strategy is defined).

Author:

Kelly Tisdell

Method Summary

Methods

Modifier and Type	Method and Description
void	decrementInventory(Map<Sku,Integer> skuQuantities) Attempts to decrement inventory for a map of Skus and quantities.
void	decrementInventory(Sku sku, int quantity) Attempts to decrement inventory if it is available.
void	incrementInventory(Map<Sku,Integer> skuQuantities) Attempts to increment inventory for a map of Skus and quantities.
void	incrementInventory(Sku sku, int quantity) Attempts to increment inventory.
boolean	isAvailable(Sku sku, int quantity) Indicates whether the given quantity is available for the particular skuId.
Map<Sku,Integer>	retrieveQuantitiesAvailable(Set<Sku> skus) Retrieves the quantities available for a set of Skus.
Integer	retrieveQuantityAvailable(Sku sku) Retrieves the quantity available for a particular sku.

Method Detail

retrieveQuantityAvailable

Integer retrieveQuantityAvailable(Sku sku)

Retrieves the quantity available for a particular sku. May return null if no inventory is maintained for the given sku. This is the case when Sku.getInventoryType() == null or not Sku.getInventoryType().equals(InventoryType.ALWAYS_AVAILABLE). Effectively, if the quantity returned is null, inventory is undefined, which most likely means it is available. However, rather than returning an arbitrary integer values (like Integer.MAX_VALUE), which has specific meaning, we return null as this can be interpreted by the client to mean whatever they define it as (including infinitely available), which is the most likely scenario.

Parameters:

skuId -

Returns:

retrieveQuantitiesAvailable

Map<Sku,Integer> retrieveQuantitiesAvailable(Set<Sku> skus)

Retrieves the quantities available for a set of Skus. The values in the map returned may be null if no inventory is maintained for the given sku. This is the case when Sku.getInventoryType() == null or not Sku.getInventoryType().equals(InventoryType.ALWAYS_AVAILABLE). Effectively, if a quantity returned is null, inventory is undefined, which most likely means it is available. However, rather than returning an arbitrary integer values (like Integer.MAX_VALUE), which has specific meaning, we return null as this can be interpreted by the client to mean whatever they define it as (including infinitely available), which is the most likely scenario.

Parameters:

skuIds -

Returns:

isAvailable

boolean isAvailable(Sku sku,
                  int quantity)

Indicates whether the given quantity is available for the particular skuId. The result will be true if Sku.getInventoryType() == null or not Sku.getInventoryType().equals(InventoryType.ALWAYS_AVAILABLE). The result will be false if the Sku is inactive, if the Sku.getAvaialable() == false, if the quantity field is null, or if the quantity requested exceeds the quantity available.

Parameters:

skuId -

quantity -

Returns:

decrementInventory

void decrementInventory(Sku sku,
                      int quantity)
                        throws InventoryUnavailableException

Attempts to decrement inventory if it is available. If the Sku is marked as InventoryType.ALWAYS_AVAILABLE then this is a no-op.

Parameters:

skuId -

quantity -

Throws:

InventoryUnavailableException

decrementInventory

void decrementInventory(Map<Sku,Integer> skuQuantities)
                        throws InventoryUnavailableException

Attempts to decrement inventory for a map of Skus and quantities. Quantities must be greater than zero or an IllegalArgumentException will be thrown.

Parameters:

skuQuantities -

Throws:

InventoryUnavailableException

incrementInventory

void incrementInventory(Sku sku,
                      int quantity)

Attempts to increment inventory. Quantity must be greater than zero or an IllegalArgumentException will be thrown.

Parameters:

skuId -

quantity -

incrementInventory

void incrementInventory(Map<Sku,Integer> skuQuantities)

Attempts to increment inventory for a map of Skus and quantities. Quantities must not be null and must be greater than zero or an IllegalArgumentException will be thrown.

Parameters:

skuQuantities -