com.broadleafcommerce.inventory.advanced.dao

Interface AdvancedInventoryDao

All Known Implementing Classes:

AdvancedInventoryDaoImpl

public interface AdvancedInventoryDao

Queries the database for various inventory function. Note that some methods in this dao can throw ConcurrentInventoryModificationException if the queried Inventory record has been locked for updating.

Author:

Kelly Tisdell, Phillip Verheyden (phillipuniverse)

Method Summary

Modifier and Type	Method and Description
void	delete(Inventory inventory) Deletes the Inventory
void	deleteReservation(InventoryReservation reservation) Deletes the reservation from the system
Inventory	readById(Long id)
Inventory	readForUpdateById(Long id) Same as read, but refreshes and handles locking for concurrent updates
List<Inventory>	readInventoriesForUpdateFromSkus(Set<Long> skus, FulfillmentLocation fulfillmentLocation)
Inventory	readInventory(org.broadleafcommerce.core.catalog.domain.Sku sku, FulfillmentLocation fulfillmentLocation) Retrieves the Inventory for the given Sku and FulfillmentLocation
List<Inventory>	readInventoryAcrossFulfillmentLocations(org.broadleafcommerce.core.catalog.domain.Sku sku) Returns all of the inventory records for the given sku within all {@link FulfillmentLocations
List<Inventory>	readInventoryAcrossFulfillmentLocations(org.broadleafcommerce.core.catalog.domain.Sku sku, org.broadleafcommerce.core.order.service.type.FulfillmentType fulfillmentType) Returns all of the inventory records for the given sku at FulfillmentLocations with the given fulfillmentType
int	readInventoryCountAcrossFulfillmentLocations(org.broadleafcommerce.core.catalog.domain.Sku sku) Reads a sum of all available quantities for a Sku across all fulfillment locations.
int	readInventoryCountInFulfillmentLocations(org.broadleafcommerce.core.catalog.domain.Sku sku, List<FulfillmentLocation> locations) Sums all of the Inventory.getQuantityAvailable() for
Inventory	readInventoryForDefaultFulfillmentLocation(org.broadleafcommerce.core.catalog.domain.Sku sku) Retrieves the Inventory for the given Sku
List<Inventory>	readInventoryForFulfillmentLocation(FulfillmentLocation fulfillmentLocation) Retrieves all instances of Inventory for this fulfillmentLocation
List<Inventory>	readInventoryForFulfillmentLocation(List<org.broadleafcommerce.core.catalog.domain.Sku> skus, FulfillmentLocation fulfillmentLocation) Reads inventories for a list of skus in the default fulfillment location.
Inventory	readInventoryForUpdate(org.broadleafcommerce.core.catalog.domain.Sku sku, FulfillmentLocation fulfillmentLocation) Same as readInventory but refreshes and locks the object.
Inventory	readInventoryForUpdateForDefaultFulfillmentLocation(org.broadleafcommerce.core.catalog.domain.Sku sku) Same as readInventoryForDefaultFulfillmentLocation but refreshes and locks the object.
int	readMaxInventoryAcrossFulfillmentLocations(org.broadleafcommerce.core.catalog.domain.Sku sku) Gets the maximum quantity at a single fulfillment location for the given sku acros all locations
int	readMaxInventoryInFulfillmentLocations(org.broadleafcommerce.core.catalog.domain.Sku sku, List<FulfillmentLocation> locations) Gets the maximum quantity at a single fulfillment location for the given sku filtered by the given locations
Inventory	save(Inventory inventory) Persists the Inventory
InventoryReservation	saveReservation(InventoryReservation reservation) Saves the given reservation

Method Detail

readById

Inventory readById(Long id)

readForUpdateById

Inventory readForUpdateById(Long id)
                     throws ConcurrentInventoryModificationException

Same as read, but refreshes and handles locking for concurrent updates

Parameters:

id -

Returns:

Throws:

{@link - ConcurrentInventoryModificationException}

ConcurrentInventoryModificationException

readInventory

Inventory readInventory(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

readInventoryForUpdate

Inventory readInventoryForUpdate(org.broadleafcommerce.core.catalog.domain.Sku sku,
                                 FulfillmentLocation fulfillmentLocation)
                          throws ConcurrentInventoryModificationException

Same as readInventory but refreshes and locks the object.

Parameters:

sku -

fulfillmentLocation -

Returns:

Throws:

ConcurrentInventoryModificationException

readInventoriesForUpdateFromSkus

List<Inventory> readInventoriesForUpdateFromSkus(Set<Long> skus,
                                                 FulfillmentLocation fulfillmentLocation)
                                          throws ConcurrentInventoryModificationException

Throws:

ConcurrentInventoryModificationException

readInventoryForDefaultFulfillmentLocation

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

Retrieves the Inventory for the given Sku

Parameters:

sku - Sku

Returns:

List

readInventoryForFulfillmentLocation

List<Inventory> readInventoryForFulfillmentLocation(List<org.broadleafcommerce.core.catalog.domain.Sku> skus,
                                                    FulfillmentLocation fulfillmentLocation)

Reads inventories for a list of skus in the default fulfillment location.

Parameters:

skus -

Returns:

readInventoryForUpdateForDefaultFulfillmentLocation

Inventory readInventoryForUpdateForDefaultFulfillmentLocation(org.broadleafcommerce.core.catalog.domain.Sku sku)
                                                       throws ConcurrentInventoryModificationException

Same as readInventoryForDefaultFulfillmentLocation but refreshes and locks the object.

Parameters:

sku -

Returns:

Throws:

ConcurrentInventoryModificationException

save

Inventory save(Inventory inventory)
        throws ConcurrentInventoryModificationException

Persists the Inventory

Parameters:

inventory - Inventory

Returns:

the persisted Inventory

Throws:

ConcurrentInventoryModificationException

delete

void delete(Inventory inventory)

Deletes the Inventory

Parameters:

inventory -

readInventoryForFulfillmentLocation

List<Inventory> readInventoryForFulfillmentLocation(FulfillmentLocation fulfillmentLocation)

Retrieves all instances of Inventory for this fulfillmentLocation

Parameters:

fulfillmentLocation -

Returns:

list of Inventory

readInventoryCountAcrossFulfillmentLocations

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

Reads a sum of all available quantities for a Sku across all fulfillment locations.

Parameters:

sku -

Returns:

readMaxInventoryAcrossFulfillmentLocations

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

Gets the maximum quantity at a single fulfillment location for the given sku acros all locations

Parameters:

sku -

Returns:

readInventoryCountInFulfillmentLocations

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

Sums all of the Inventory.getQuantityAvailable() for

Parameters:

sku -

locations -

Returns:

readMaxInventoryInFulfillmentLocations

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

Gets the maximum quantity at a single fulfillment location for the given sku filtered by the given locations

Parameters:

sku -

locations -

Returns:

readInventoryAcrossFulfillmentLocations

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

Returns all of the inventory records for the given sku within all {@link FulfillmentLocations

Parameters:

sku - the Sku to find inventory for

Returns:

inventory at all of the configured FulfillmentLocations

readInventoryAcrossFulfillmentLocations

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

Returns all of the inventory records for the given sku at FulfillmentLocations with the given fulfillmentType

Parameters:

sku - the {@link s

fulfillmentType - the type of FulfillmentLocations to check

Returns:

inventory at all FulfillmentLocations filtered by the given fulfillmentType

See Also:

FulfillmentTypeHelper}

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