org.broadleafcommerce.inventory.basic.service

Class BasicInventoryServiceImpl

java.lang.Object

org.broadleafcommerce.inventory.basic.service.BasicInventoryServiceImpl

All Implemented Interfaces:

BasicInventoryService

public class BasicInventoryServiceImpl
extends Object
implements BasicInventoryService

Field Summary

Fields

Modifier and Type	Field and Description
protected org.broadleafcommerce.core.catalog.service.CatalogService	catalogService
protected BasicInventoryDao	inventoryDao

Constructor Summary

Constructors

Constructor and Description
BasicInventoryServiceImpl()

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	checkBasicAvailablility(org.broadleafcommerce.core.catalog.domain.Sku sku)
void	decrementInventory(Long skuId, int quantity) Attempts to decrement inventory if it is available.
void	decrementInventory(Map<Long,Integer> skuQuantities) Attempts to decrement inventory for a map of Sku ids and quantities.
void	incrementInventory(Long skuId, int quantity) Attempts to increment inventory.
void	incrementInventory(Map<Long,Integer> skuQuantities) Attempts to increment inventory for a map of Sku ids and quantities.
boolean	isAvailable(Long skuId, int quantity) Indicates whether the given quantity is available for the particular skuId.
Map<Long,Integer>	retrieveQuantitiesAvailable(Set<Long> skuIds) Retrieves the quantities available for a set of sku ids.
Integer	retrieveQuantityAvailable(Long skuId) Retrieves the quantity available for a particular sku.
void	setCatalogService(org.broadleafcommerce.core.catalog.service.CatalogService catalogService)
void	setInventoryDao(BasicInventoryDao inventoryDao)

Methods inherited from class java.lang.Object

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

Field Detail

inventoryDao

protected BasicInventoryDao inventoryDao

catalogService

protected org.broadleafcommerce.core.catalog.service.CatalogService catalogService

Constructor Detail

BasicInventoryServiceImpl

public BasicInventoryServiceImpl()

Method Detail

checkBasicAvailablility

protected boolean checkBasicAvailablility(org.broadleafcommerce.core.catalog.domain.Sku sku)

retrieveQuantityAvailable

@Transactional(value="blTransactionManager")
public Integer retrieveQuantityAvailable(Long skuId)

Description copied from interface: BasicInventoryService

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.BASIC). 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 BasicInventoryService

Returns:

retrieveQuantitiesAvailable

@Transactional(value="blTransactionManager")
public Map<Long,Integer> retrieveQuantitiesAvailable(Set<Long> skuIds)

Description copied from interface: BasicInventoryService

Retrieves the quantities available for a set of sku ids. 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.BASIC). 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 BasicInventoryService

Returns:

isAvailable

@Transactional(value="blTransactionManager")
public boolean isAvailable(Long skuId,
                                int quantity)

Description copied from interface: BasicInventoryService

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.BASIC). The result will be false if the Sku is inactive, if the Sku.getAvaialbe() == false, if the quantity field is null, or if the quantity requested exceeds the quantity available.

Specified by:

isAvailable in interface BasicInventoryService

Returns:

decrementInventory

@Transactional(value="blTransactionManager",
               rollbackFor=BasicInventoryUnavailableException.class)
public void decrementInventory(Long skuId,
                                                                            int quantity)
                        throws BasicInventoryUnavailableException

Description copied from interface: BasicInventoryService

Attempts to decrement inventory if it is available.

Specified by:

decrementInventory in interface BasicInventoryService

Throws:

BasicInventoryUnavailableException

decrementInventory

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

Description copied from interface: BasicInventoryService

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

Specified by:

decrementInventory in interface BasicInventoryService

Throws:

BasicInventoryUnavailableException

incrementInventory

@Transactional(value="blTransactionManager")
public void incrementInventory(Long skuId,
                                    int quantity)

Description copied from interface: BasicInventoryService

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

Specified by:

incrementInventory in interface BasicInventoryService

incrementInventory

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

Description copied from interface: BasicInventoryService

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

Specified by:

incrementInventory in interface BasicInventoryService

setInventoryDao

public void setInventoryDao(BasicInventoryDao inventoryDao)

setCatalogService

public void setCatalogService(org.broadleafcommerce.core.catalog.service.CatalogService catalogService)