com.broadleafcommerce.inventory.advanced.dao

Class AdvancedInventoryDaoImpl

java.lang.Object

com.broadleafcommerce.inventory.advanced.dao.AdvancedInventoryDaoImpl

All Implemented Interfaces:

AdvancedInventoryDao

@Repository(value="blAdvancedInventoryDao")
public class AdvancedInventoryDaoImpl
extends Object
implements AdvancedInventoryDao

Field Summary

Fields

Modifier and Type	Field and Description
protected javax.persistence.EntityManager	em
protected FulfillmentTypeHelper	fulfillmentTypeHelper
protected org.broadleafcommerce.common.sandbox.SandBoxHelper	sandBoxHelper

Constructor Summary

Constructors

Constructor and Description
AdvancedInventoryDaoImpl()

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

Methods inherited from class java.lang.Object

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

Field Detail

fulfillmentTypeHelper

protected FulfillmentTypeHelper fulfillmentTypeHelper

em

protected javax.persistence.EntityManager em

sandBoxHelper

protected org.broadleafcommerce.common.sandbox.SandBoxHelper sandBoxHelper

Constructor Detail

AdvancedInventoryDaoImpl

public AdvancedInventoryDaoImpl()

Method Detail

save

public Inventory save(Inventory inventory)
               throws ConcurrentInventoryModificationException

Description copied from interface: AdvancedInventoryDao

Persists the Inventory

Specified by:

save in interface AdvancedInventoryDao

Parameters:

inventory - Inventory

Returns:

the persisted Inventory

Throws:

ConcurrentInventoryModificationException

readInventory

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

Description copied from interface: AdvancedInventoryDao

Retrieves the Inventory for the given Sku and FulfillmentLocation

Specified by:

readInventory in interface AdvancedInventoryDao

Parameters:

sku - Sku

fulfillmentLocation - FulfillmentLocation

Returns:

Inventory

readInventoryForUpdate

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

Description copied from interface: AdvancedInventoryDao

Same as readInventory but refreshes and locks the object.

Specified by:

readInventoryForUpdate in interface AdvancedInventoryDao

Returns:

Throws:

ConcurrentInventoryModificationException

readInventoriesForUpdateFromSkus

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

Specified by:

readInventoriesForUpdateFromSkus in interface AdvancedInventoryDao

Throws:

ConcurrentInventoryModificationException

readInventoryForDefaultFulfillmentLocation

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

Description copied from interface: AdvancedInventoryDao

Retrieves the Inventory for the given Sku

Specified by:

readInventoryForDefaultFulfillmentLocation in interface AdvancedInventoryDao

Parameters:

sku - Sku

Returns:

List

readInventoryForUpdateForDefaultFulfillmentLocation

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

Description copied from interface: AdvancedInventoryDao

Same as readInventoryForDefaultFulfillmentLocation but refreshes and locks the object.

Specified by:

readInventoryForUpdateForDefaultFulfillmentLocation in interface AdvancedInventoryDao

Returns:

Throws:

ConcurrentInventoryModificationException

delete

public void delete(Inventory inventory)

Description copied from interface: AdvancedInventoryDao

Deletes the Inventory

Specified by:

delete in interface AdvancedInventoryDao

readById

public Inventory readById(Long id)

Specified by:

readById in interface AdvancedInventoryDao

readForUpdateById

public Inventory readForUpdateById(Long id)
                            throws ConcurrentInventoryModificationException

Description copied from interface: AdvancedInventoryDao

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

Specified by:

readForUpdateById in interface AdvancedInventoryDao

Returns:

Throws:

ConcurrentInventoryModificationException

readInventoryForFulfillmentLocation

public List<Inventory> readInventoryForFulfillmentLocation(FulfillmentLocation fulfillmentLocation)

Description copied from interface: AdvancedInventoryDao

Retrieves all instances of Inventory for this fulfillmentLocation

Specified by:

readInventoryForFulfillmentLocation in interface AdvancedInventoryDao

Returns:

list of Inventory

readInventoryForFulfillmentLocation

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

Description copied from interface: AdvancedInventoryDao

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

Specified by:

readInventoryForFulfillmentLocation in interface AdvancedInventoryDao

Returns:

readInventoryCountAcrossFulfillmentLocations

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

Description copied from interface: AdvancedInventoryDao

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

Specified by:

readInventoryCountAcrossFulfillmentLocations in interface AdvancedInventoryDao

Returns:

readMaxInventoryAcrossFulfillmentLocations

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

Description copied from interface: AdvancedInventoryDao

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

Specified by:

readMaxInventoryAcrossFulfillmentLocations in interface AdvancedInventoryDao

Returns:

readInventoryCountInFulfillmentLocations

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

Description copied from interface: AdvancedInventoryDao

Sums all of the Inventory.getQuantityAvailable() for

Specified by:

readInventoryCountInFulfillmentLocations in interface AdvancedInventoryDao

Returns:

readMaxInventoryInFulfillmentLocations

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

Description copied from interface: AdvancedInventoryDao

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

Specified by:

readMaxInventoryInFulfillmentLocations in interface AdvancedInventoryDao

Returns:

readInventoryAcrossFulfillmentLocations

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

Description copied from interface: AdvancedInventoryDao

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

Specified by:

readInventoryAcrossFulfillmentLocations in interface AdvancedInventoryDao

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}

readInventoryAcrossFulfillmentLocations

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

Description copied from interface: AdvancedInventoryDao

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

Specified by:

readInventoryAcrossFulfillmentLocations in interface AdvancedInventoryDao

Parameters:

sku - the Sku to find inventory for

Returns:

inventory at all of the configured FulfillmentLocations

saveReservation

public InventoryReservation saveReservation(InventoryReservation reservation)

Description copied from interface: AdvancedInventoryDao

Saves the given reservation

Specified by:

saveReservation in interface AdvancedInventoryDao

Parameters:

reservation - the entity to save

Returns:

the merged version of the given instance

deleteReservation

public void deleteReservation(InventoryReservation reservation)

Description copied from interface: AdvancedInventoryDao

Deletes the reservation from the system

Specified by:

deleteReservation in interface AdvancedInventoryDao

Parameters:

reservation - the InventoryReservation to delete