com.broadleafcommerce.inventory.advanced.service

Interface AdvancedInventoryService

All Superinterfaces:

org.broadleafcommerce.core.inventory.service.InventoryService

All Known Implementing Classes:

AdvancedInventoryServiceImpl

public interface AdvancedInventoryService
extends org.broadleafcommerce.core.inventory.service.InventoryService

Advanced inventory service for checking inventory availablity and modifying quantities. Take care with transactions as methods that modify inventory counts (InventoryService.decrementInventory(Map) and decrementInventoryOnHand(Map)) could roll back transactions from optimistic NOTE: If you wrap this service inside another service or transactional component, it may be best to ensure that transactions are rolled back when encountering checked exceptions that are thrown from this service, such as InventoryUnavailableException and ConcurrentInventoryModificationException

Author:

Kelly Tisdell

Method Summary

Modifier and Type	Method and Description
void	decrementInventoryFromLocations(Map<FulfillmentLocation,Map<org.broadleafcommerce.core.catalog.domain.Sku,Integer>> skuInventory) Subtracts the quantity from available inventory for each sku in the map for the given fulfillment location.
void	decrementInventoryFromLocations(Map<FulfillmentLocation,Map<org.broadleafcommerce.core.catalog.domain.Sku,Integer>> skuInventory, List<InventoryReservation> reservations) The same as decrementInventoryFromLocations(Map) except that this will also persist the given reservations so that everything can be apart of a single transaction
void	decrementInventoryOnHand(Map<FulfillmentLocation,Map<org.broadleafcommerce.core.catalog.domain.Sku,Integer>> skuInventory) Subtracts the quantity from inventory on hand for each sku in the map for the given fulfillment location.
void	deleteReservation(InventoryReservation reservation) Deletes the reservation from the system
Inventory	findInventory(org.broadleafcommerce.core.catalog.domain.Sku sku) Retrieves inventory for this sku at the default fulfillment location.
Inventory	findInventory(org.broadleafcommerce.core.catalog.domain.Sku sku, FulfillmentLocation fulfillmentLocation) Retrieves the Inventory for the given Sku and FulfillmentLocation
List<Inventory>	findInventoryAcrossFulfillmentLocations(org.broadleafcommerce.core.catalog.domain.Sku sku) Gets the list of inventory across all FulfillmentLocations for the given sku
List<Inventory>	findInventoryAcrossFulfillmentLocations(org.broadleafcommerce.core.catalog.domain.Sku sku, org.broadleafcommerce.core.order.service.type.FulfillmentType fulfillmentType) Obtains all the Inventory records across all FulfillmentLocations for the given FulfillmentType
int	findInventoryCountAcrossFulfillmentLocations(org.broadleafcommerce.core.catalog.domain.Sku sku) Counts the quantity available across all FulfillmentLocations
int	findInventoryCountAcrossFulfillmentLocations(org.broadleafcommerce.core.catalog.domain.Sku sku, org.broadleafcommerce.core.order.service.type.FulfillmentType fulfillmentType) Counts the quantity available across all FulfillmentLocations for the given FulfillmentType
int	findInventoryCountInFulfillmentLocations(org.broadleafcommerce.core.catalog.domain.Sku sku, List<FulfillmentLocation> locations) Counts the quantity available across the given set of locations for a given sku
List<Inventory>	findInventoryForFulfillmentLocation(FulfillmentLocation fulfillmentLocation) Retrieves all instances of Inventory for this fulfillmentLocation
int	findMaxInventoryAcrossFulfillmentLocations(org.broadleafcommerce.core.catalog.domain.Sku sku) Gets the maximum quantity available in a single FulfillmentLocation for the given sku across all FulfillmentLocations
int	findMaxInventoryInFulfillmentLocations(org.broadleafcommerce.core.catalog.domain.Sku sku, List<FulfillmentLocation> locations) Gets the maximum quantity available in a single FulfillmentLocation for the given sku filtered by the list of given locations
void	incrementInventoryFromLocations(Map<FulfillmentLocation,Map<org.broadleafcommerce.core.catalog.domain.Sku,Integer>> skuInventory) Add available inventory to sku.
void	incrementInventoryFromLocations(Map<FulfillmentLocation,Map<org.broadleafcommerce.core.catalog.domain.Sku,Integer>> skuInventory, List<InventoryReservation> reservations)
void	incrementInventoryOnHand(Map<FulfillmentLocation,Map<org.broadleafcommerce.core.catalog.domain.Sku,Integer>> skuInventory) Add inventory on hand to sku.
Map<org.broadleafcommerce.core.catalog.domain.Sku,Boolean>	isAvailable(org.broadleafcommerce.core.catalog.domain.Product product, Integer quantity) Returns a map indicating if the quantity requested is available for each sku associated with the Product in the default fulfillment location.
Map<org.broadleafcommerce.core.catalog.domain.Sku,Boolean>	isAvailable(org.broadleafcommerce.core.catalog.domain.Product product, Integer quantity, FulfillmentLocation fulfillmentLocation) Returns a map indicating whether the quantity requested is available for the specified Product in the fulfillment location.
boolean	isAvailable(org.broadleafcommerce.core.catalog.domain.Sku sku, Integer quantity, FulfillmentLocation fulfillmentLocation) Retrieves whether or not the quantity is available for a sku at a fulfillment location.
boolean	isAvailable(org.broadleafcommerce.core.catalog.domain.Sku sku, int quantity, List<FulfillmentLocation> locations) Determines if quantity is available for the given sku at the given locations
boolean	isAvailableAtDefaultFulfillmentLocation(org.broadleafcommerce.core.catalog.domain.Sku sku, Integer quantity) Retrieves whether or not the quantity is available for a sku at the default fulfillment location.
boolean	isSkuEligibleForInventoryCheck(org.broadleafcommerce.core.catalog.domain.Sku sku) Tests whether an inventory check will be invoked for the given Sku.
boolean	isSkuEligibleForReservation(org.broadleafcommerce.core.catalog.domain.Sku sku) Tests whether a reservation will be created for a given Sku.
Inventory	save(Inventory inventory) Persists the inventory
InventoryReservation	saveReservation(InventoryReservation reservation) Saves the given reservation
void	setInventory(Map<FulfillmentLocation,List<UpdateInventoryInfo>> inventoryInfos) Sets the on hand and available quantities for a sku at a fulfillment location.

Methods inherited from interface org.broadleafcommerce.core.inventory.service.InventoryService

checkBasicAvailablility, decrementInventory, decrementInventory, incrementInventory, incrementInventory, isAvailable, retrieveQuantitiesAvailable, retrieveQuantityAvailable

Method Detail

isSkuEligibleForInventoryCheck

boolean isSkuEligibleForInventoryCheck(org.broadleafcommerce.core.catalog.domain.Sku sku)

Tests whether an inventory check will be invoked for the given Sku.

Parameters:

sku -

Returns:

isSkuEligibleForReservation

boolean isSkuEligibleForReservation(org.broadleafcommerce.core.catalog.domain.Sku sku)

Tests whether a reservation will be created for a given Sku.

Parameters:

sku -

Returns:

isAvailableAtDefaultFulfillmentLocation

boolean isAvailableAtDefaultFulfillmentLocation(org.broadleafcommerce.core.catalog.domain.Sku sku,
                                                Integer quantity)

Retrieves whether or not the quantity is available for a sku at the default fulfillment location.

Parameters:

sku - the sku

quantity - the amount for which to check; must be a positive integer

Returns:

the boolean result of whether or not the quantity is available

isAvailable

Map<org.broadleafcommerce.core.catalog.domain.Sku,Boolean> isAvailable(org.broadleafcommerce.core.catalog.domain.Product product,
                                                                       Integer quantity)

Returns a map indicating if the quantity requested is available for each sku associated with the Product in the default fulfillment location.

Parameters:

product -

quantity -

Returns:

isAvailable

boolean isAvailable(org.broadleafcommerce.core.catalog.domain.Sku sku,
                    Integer quantity,
                    FulfillmentLocation fulfillmentLocation)

Retrieves whether or not the quantity is available for a sku at a fulfillment location. If fulfillmentLocation is not supplied, this will check all fulfillment locations for availability.

Parameters:

sku - the sku

quantity - the amount for which to check; must be a positive integer

fulfillmentLocation - the fulfillment location

Returns:

boolean result of whether or not the specified quantity is available

isAvailable

boolean isAvailable(org.broadleafcommerce.core.catalog.domain.Sku sku,
                    int quantity,
                    List<FulfillmentLocation> locations)

Determines if quantity is available for the given sku at the given locations

Parameters:

sku - the Sku to check

quantity - the quantity that should be verified for availability

locations - the locations that should be checked for the given sku

Returns:

true if Inventory.getQuantityAvailable() at any of the given locations is greater than or equal to the given quantity, false otherwise.

See Also:

#findInventoryCountInFulfillmentLocations(Sku, List)}

isAvailable

Map<org.broadleafcommerce.core.catalog.domain.Sku,Boolean> isAvailable(org.broadleafcommerce.core.catalog.domain.Product product,
                                                                       Integer quantity,
                                                                       FulfillmentLocation fulfillmentLocation)

Returns a map indicating whether the quantity requested is available for the specified Product in the fulfillment location.

Parameters:

product -

quantity -

fulfillmentLocation -

Returns:

decrementInventoryFromLocations

void decrementInventoryFromLocations(Map<FulfillmentLocation,Map<org.broadleafcommerce.core.catalog.domain.Sku,Integer>> skuInventory)
                              throws ConcurrentInventoryModificationException,
                                     org.broadleafcommerce.core.inventory.service.InventoryUnavailableException

Subtracts the quantity from available inventory for each sku in the map for the given fulfillment location. Quantity must be a positive integer.

Parameters:

skuInventory - a map which contains the quantity of inventory to subtract from available inventory for each sku

fulfillmentLocation - the fulfillment location

Throws:

ConcurrentInventoryModificationException

org.broadleafcommerce.core.inventory.service.InventoryUnavailableException

decrementInventoryFromLocations

void decrementInventoryFromLocations(Map<FulfillmentLocation,Map<org.broadleafcommerce.core.catalog.domain.Sku,Integer>> skuInventory,
                                     List<InventoryReservation> reservations)
                              throws ConcurrentInventoryModificationException,
                                     org.broadleafcommerce.core.inventory.service.InventoryUnavailableException

The same as decrementInventoryFromLocations(Map) except that this will also persist the given reservations so that everything can be apart of a single transaction

Parameters:

skuInventory - the inventory map to decrement

reservations - optional list of reservations that should be persisted along with the new decremented inventory values

Throws:

ConcurrentInventoryModificationException

org.broadleafcommerce.core.inventory.service.InventoryUnavailableException

decrementInventoryOnHand

void decrementInventoryOnHand(Map<FulfillmentLocation,Map<org.broadleafcommerce.core.catalog.domain.Sku,Integer>> skuInventory)
                       throws ConcurrentInventoryModificationException,
                              org.broadleafcommerce.core.inventory.service.InventoryUnavailableException

Subtracts the quantity from inventory on hand for each sku in the map for the given fulfillment location. Specified quantity must be a positive integer. This is typically done when inventory is shipped or fulfilled.

Parameters:

skuInventory -

fulfillmentLocation -

Throws:

ConcurrentInventoryModificationException

org.broadleafcommerce.core.inventory.service.InventoryUnavailableException

incrementInventoryFromLocations

void incrementInventoryFromLocations(Map<FulfillmentLocation,Map<org.broadleafcommerce.core.catalog.domain.Sku,Integer>> skuInventory)
                              throws ConcurrentInventoryModificationException

Add available inventory to sku. If fulfillment location is null, this method throws an IllegalArgumentException.

Parameters:

skuInventory -

fulfillmentLocation -

Throws:

ConcurrentInventoryModificationException

incrementInventoryFromLocations

void incrementInventoryFromLocations(Map<FulfillmentLocation,Map<org.broadleafcommerce.core.catalog.domain.Sku,Integer>> skuInventory,
                                     List<InventoryReservation> reservations)
                              throws ConcurrentInventoryModificationException

Throws:

ConcurrentInventoryModificationException

incrementInventoryOnHand

void incrementInventoryOnHand(Map<FulfillmentLocation,Map<org.broadleafcommerce.core.catalog.domain.Sku,Integer>> skuInventory)
                       throws ConcurrentInventoryModificationException

Add inventory on hand to sku. If fulfillment location is null, this method throws an IllegalArgumentException.

Parameters:

skuInventory -

fulfillmentLocation -

Throws:

ConcurrentInventoryModificationException

setInventory

void setInventory(Map<FulfillmentLocation,List<UpdateInventoryInfo>> inventoryInfos)
           throws ConcurrentInventoryModificationException

Sets the on hand and available quantities for a sku at a fulfillment location. If no inventory record exists for the sku/fulfillment location pair then one is made. If both quantity on hand and quantity available are null then an IllegalArgumentException is thrown. If the fulfillment location is null then an IllegalArgumentException is thrown.

Parameters:

inventoryInfos -

Throws:

ConcurrentInventoryModificationException

findInventory

Inventory findInventory(org.broadleafcommerce.core.catalog.domain.Sku sku,
                        FulfillmentLocation fulfillmentLocation)

Retrieves the Inventory for the given Sku and FulfillmentLocation

Parameters:

sku - Sku

fulfillmentLocation - FulfillmentLocation

Returns:

Inventory

findInventory

Inventory findInventory(org.broadleafcommerce.core.catalog.domain.Sku sku)

Retrieves inventory for this sku at the default fulfillment location.

Parameters:

sku -

Returns:

findInventoryForFulfillmentLocation

List<Inventory> findInventoryForFulfillmentLocation(FulfillmentLocation fulfillmentLocation)

Retrieves all instances of Inventory for this fulfillmentLocation

Parameters:

fulfillmentLocation -

Returns:

list of Inventory

save

Inventory save(Inventory inventory)
        throws ConcurrentInventoryModificationException

Persists the inventory

Returns:

a Hibernate-merged instance of inventory

Throws:

ConcurrentInventoryModificationException

findInventoryCountAcrossFulfillmentLocations

int findInventoryCountAcrossFulfillmentLocations(org.broadleafcommerce.core.catalog.domain.Sku sku)

Counts the quantity available across all FulfillmentLocations

Parameters:

sku - the Sku to look for inventory for

Returns:

the sum of quantity available across all FulfillmentLocations for this Sku

See Also:

#findInventoryAcrossFulfillmentLocations(Sku)}

findInventoryCountAcrossFulfillmentLocations

int findInventoryCountAcrossFulfillmentLocations(org.broadleafcommerce.core.catalog.domain.Sku sku,
                                                 org.broadleafcommerce.core.order.service.type.FulfillmentType fulfillmentType)

Counts the quantity available across all FulfillmentLocations for the given FulfillmentType

Parameters:

sku - the Sku from the catalog to find inventory for

fulfillmentType - restriction on the types of FulfillmentLocations that should be checked for inventory

Returns:

the full sum of Inventory.getQuantityAvailable() for the given sku within FulfillmentLocations filtered by the given fulfillmentType

See Also:

#findInventoryAcrossFulfillmentLocations(Sku, FulfillmentType)}

findMaxInventoryAcrossFulfillmentLocations

int findMaxInventoryAcrossFulfillmentLocations(org.broadleafcommerce.core.catalog.domain.Sku sku)

Gets the maximum quantity available in a single FulfillmentLocation for the given sku across all FulfillmentLocations

Parameters:

sku - the Sku to find inventory for

Returns:

the maximum single-location inventory for the given sku. If the given sku is not in any FulfillmentLocations then this will return 0

findInventoryCountInFulfillmentLocations

int findInventoryCountInFulfillmentLocations(org.broadleafcommerce.core.catalog.domain.Sku sku,
                                             List<FulfillmentLocation> locations)

Counts the quantity available across the given set of locations for a given sku

Parameters:

sku - the Sku from the catalog to find inventory for

locations - restriction on the FulfillmentLocations to count inventory for

Returns:

the sum of all of the Inventory.getQuantityAvailable() across all of the fulfillment locations

findMaxInventoryInFulfillmentLocations

int findMaxInventoryInFulfillmentLocations(org.broadleafcommerce.core.catalog.domain.Sku sku,
                                           List<FulfillmentLocation> locations)

Gets the maximum quantity available in a single FulfillmentLocation for the given sku filtered by the list of given locations

Parameters:

sku - the Sku to find inventory for

locations - a subset of FulfillmentLocations to look for inventory

Returns:

the maximum single-location inventory for the given sku. If locations is empty or null or if the given sku is not in any of the given locations then this will return 0

findInventoryAcrossFulfillmentLocations

List<Inventory> findInventoryAcrossFulfillmentLocations(org.broadleafcommerce.core.catalog.domain.Sku sku)

Gets the list of inventory across all FulfillmentLocations for the given sku

Parameters:

sku - the Sku to find inventory for

Returns:

the list of Inventory for the given sku

See Also:

#findInventoryAcrossFulfillmentLocations(Sku, FulfillmentType)}, #findInventoryCountAcrossFulfillmentLocations(Sku)}

findInventoryAcrossFulfillmentLocations

List<Inventory> findInventoryAcrossFulfillmentLocations(org.broadleafcommerce.core.catalog.domain.Sku sku,
                                                        @Nullable
                                                        org.broadleafcommerce.core.order.service.type.FulfillmentType fulfillmentType)

Obtains all the Inventory records across all FulfillmentLocations for the given FulfillmentType

Parameters:

sku - the Sku from the catalog to find inventory for

fulfillmentType - (optional) restriction on the types of FulfillmentLocations that should be checked for inventory

Returns:

the Inventory records for the given sku within all FulfillmentLocations filtered by the given fulfillmentType

See Also:

#findInventoryCountAcrossFulfillmentLocations(Sku, FulfillmentType)}

saveReservation

InventoryReservation saveReservation(InventoryReservation reservation)

Saves the given reservation

Parameters:

reservation - the entity to save

Returns:

the merged version of the given instance

deleteReservation

void deleteReservation(InventoryReservation reservation)

Deletes the reservation from the system

Parameters:

reservation - the InventoryReservation to delete