com.broadleafcommerce.inventory.advanced.reservation.strategy

Class SingleLocationPerItemReservationStrategy

java.lang.Object

com.broadleafcommerce.inventory.advanced.reservation.strategy.AbstractInventoryReservationStrategy

com.broadleafcommerce.inventory.advanced.reservation.strategy.SingleLocationPerItemReservationStrategy

All Implemented Interfaces:

InventoryReservationStrategy

@Component(value="blSingleLocationPerItemReservationStrategy")
public class SingleLocationPerItemReservationStrategy
extends AbstractInventoryReservationStrategy

Each FulfillmentGroupItem within a FulfillmentGroup must have the entire item fulfilled from a single FulfillmentLocation.

Inventory is prioritized according to the quantity available at each location. This can be prioritized to use the maximum quantity or the minimum quantity first, and is customized using the advanced-inventory.prioritize.higher.quantity or advanced-inventory.prioritize.lower.quantity system properties.

If you are using this strategy, there is logic within AdvancedInventoryServiceExtensionHandler.retrieveQuantitiesAvailable(Collection, Map, org.broadleafcommerce.common.extension.ExtensionResultHolder). That method will invoke AdvancedInventoryService.findMaxInventoryAcrossFulfillmentLocations(Sku) since the quantity available for a FulfillmentGroupItem will have to come from a single FulfillmentLocation.

Author:

Phillip Verheyden (phillipuniverse)

Field Summary

Fields inherited from class com.broadleafcommerce.inventory.advanced.reservation.strategy.AbstractInventoryReservationStrategy

entityConfig, inventoryService

Constructor Summary

Constructors

Constructor and Description
SingleLocationPerItemReservationStrategy()

Method Summary

Modifier and Type	Method and Description
List<InventoryReservation>	getReservations(org.broadleafcommerce.core.order.domain.FulfillmentGroup fg) This attempts to resolve a fulfillment (inventory) location for a particular fulfillment group for the given Sku and quantity.
InventoryReservationStrategyType	getType() The type of this strategy, used for configuring the active strategy for selecting between.

Methods inherited from class com.broadleafcommerce.inventory.advanced.reservation.strategy.AbstractInventoryReservationStrategy

createInventoryReservation, favorHigherQuantityDecrement, favorLowerQuantityDecrement, getSkuForItem, prioritizeInventory

Methods inherited from class java.lang.Object

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

Constructor Detail

SingleLocationPerItemReservationStrategy

public SingleLocationPerItemReservationStrategy()

Method Detail

getType

public InventoryReservationStrategyType getType()

Description copied from interface: InventoryReservationStrategy

The type of this strategy, used for configuring the active strategy for selecting between.

Returns:

the type of this strategy

getReservations

public List<InventoryReservation> getReservations(org.broadleafcommerce.core.order.domain.FulfillmentGroup fg)

Description copied from interface: InventoryReservationStrategy

This attempts to resolve a fulfillment (inventory) location for a particular fulfillment group for the given Sku and quantity. This is used within the AdvancedInventoryWorkflowExtensionHandler to determine the corresponding InventoryReservations to create when checking out an Order and decrementing Inventory.

Persisting the list of InventoryReservations that is returned should occur within the same transaction that actually decrements the quantity available for an Inventory record within a FulfillmentLocation.

Parameters:

fg - the FulfillmentGroup being used to get reservations for

Returns:

a list of InventoryReservations for the given fg. If no suitable reservations could be made, this should return an empty list

See Also:

AdvancedInventoryServiceExtensionHandler#decrementInventory(java.util.Map, java.util.Map)}, AdvancedInventoryService#decrementInventoryFromLocations(java.util.Map, List)}