org.broadleafcommerce.core.inventory.service

Class InventoryServiceImpl

java.lang.Object

org.broadleafcommerce.core.inventory.service.InventoryServiceImpl

All Implemented Interfaces:

InventoryService

@Service(value="blInventoryService")
public class InventoryServiceImpl
extends Object
implements InventoryService

Field Summary

Fields

Modifier and Type	Field and Description
protected CatalogService	catalogService

Constructor Summary

Constructors

Constructor and Description
InventoryServiceImpl()

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	checkBasicAvailablility(Sku sku)
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.
void	setCatalogService(CatalogService catalogService)

Methods inherited from class java.lang.Object

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

Field Detail

catalogService

protected CatalogService catalogService

Constructor Detail

InventoryServiceImpl

public InventoryServiceImpl()

Method Detail

checkBasicAvailablility

protected boolean checkBasicAvailablility(Sku sku)

retrieveQuantityAvailable

public Integer retrieveQuantityAvailable(Sku sku)

Description copied from interface: InventoryService

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.

Specified by:

retrieveQuantityAvailable in interface InventoryService

Returns:

retrieveQuantitiesAvailable

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

Description copied from interface: InventoryService

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.

Specified by:

retrieveQuantitiesAvailable in interface InventoryService

Returns:

isAvailable

public boolean isAvailable(Sku sku,
                  int quantity)

Description copied from interface: InventoryService

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.

Specified by:

isAvailable in interface InventoryService

Returns:

decrementInventory

@Transactional(value="blTransactionManager",
               rollbackFor=InventoryUnavailableException.class)
public void decrementInventory(Sku sku,
                                                                       int quantity)
                        throws InventoryUnavailableException

Description copied from interface: InventoryService

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

Specified by:

decrementInventory in interface InventoryService

Throws:

InventoryUnavailableException

decrementInventory

@Transactional(value="blTransactionManager",
               rollbackFor=InventoryUnavailableException.class)
public void decrementInventory(Map<Sku,Integer> skuQuantities)
                        throws InventoryUnavailableException

Description copied from interface: InventoryService

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

Specified by:

decrementInventory in interface InventoryService

Throws:

InventoryUnavailableException

incrementInventory

@Transactional(value="blTransactionManager")
public void incrementInventory(Sku sku,
                                    int quantity)

Description copied from interface: InventoryService

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

Specified by:

incrementInventory in interface InventoryService

incrementInventory

@Transactional(value="blTransactionManager")
public void incrementInventory(Map<Sku,Integer> skuQuantities)

Description copied from interface: InventoryService

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.

Specified by:

incrementInventory in interface InventoryService

setCatalogService

public void setCatalogService(CatalogService catalogService)