com.broadleafcommerce.inventory.advanced.reservation.strategy

Interface InventoryReservationStrategy

All Known Implementing Classes:

AbstractInventoryReservationStrategy, MultipleReservationPerItemReservationStrategy, SingleLocationPerGroupReservationStrategy, SingleLocationPerItemReservationStrategy

public interface InventoryReservationStrategy

Configurable interface used to determine how to create InventoryReservations for a FulfillmentGroup when an order is checked out. There are a few different strategies provided out of the box that you can use directly or extend from for your own purposes. These are:

• MultipleReservationPerItemReservationStrategy
• SingleLocationPerGroupReservationStrategy
• SingleLocationPerGroupReservationStrategy

All of these out of the box strategies prioritize the the list of Inventory by minimum or maximum quantity using the advanced-inventory.prioritize.higher.quantity or advanced-inventory.prioritize.lower.quantity system properties

To create your own strategy (like one that prioritizes inventory based on location), you will need to do 3 things:

1. Create a Spring bean that implements this InventoryReservationStrategy interface
2. Create a subclass of InventoryReservationStrategyType to add your own custom type
3. Change the advanced-inventory.item.reservation.strategy system property to the value of your new InventoryReservationStrategyType.getType()

Author:

Phillip Verheyden (phillipuniverse)

See Also:

AdvancedInventoryServiceExtensionHandler#decrementInventory(java.util.Map, java.util.Map)}, AbstractInventoryReservationStrategy}, MultipleReservationPerItemReservationStrategy}, SingleLocationPerGroupReservationStrategy}, 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.
org.broadleafcommerce.core.catalog.domain.Sku	getSkuForItem(org.broadleafcommerce.core.order.domain.FulfillmentGroupItem item) Convenience method to determine the SKU from the FulfillmentGroupItem
InventoryReservationStrategyType	getType() The type of this strategy, used for configuring the active strategy for selecting between.
List<Inventory>	prioritizeInventory(List<Inventory> inventory) Takes the given list of inventory and returns a new sorted list.

Method Detail

getType

InventoryReservationStrategyType getType()

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

Returns:

the type of this strategy

getSkuForItem

org.broadleafcommerce.core.catalog.domain.Sku getSkuForItem(org.broadleafcommerce.core.order.domain.FulfillmentGroupItem item)

Convenience method to determine the SKU from the FulfillmentGroupItem

Parameters:

item -

Returns:

getReservations

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. 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)}

prioritizeInventory

List<Inventory> prioritizeInventory(List<Inventory> inventory)

Takes the given list of inventory and returns a new sorted list. Example use cases would be to sort this list by maximum inventory at a location or to exclude specific instances of inventory.

No modifications should be performed on the original list of inventory passed in.

The out-of-the-box implementations of InventoryReservationStrategy prioritize inventory according to the advanced-inventory.prioritize.higher.quantity and advanced-inventory.prioritize.lower.quantity system properties.

Parameters:

inventory - the list of Inventory to prioritize

Returns:

a prioritized list of Inventory used for reserving inventory