com.broadleafcommerce.inventory.advanced.reservation.strategy

Class AbstractInventoryReservationStrategy

java.lang.Object

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

All Implemented Interfaces:

InventoryReservationStrategy

Direct Known Subclasses:

MultipleReservationPerItemReservationStrategy, SingleLocationPerGroupReservationStrategy, SingleLocationPerItemReservationStrategy

public abstract class AbstractInventoryReservationStrategy
extends Object
implements InventoryReservationStrategy

Field Summary

Fields

Modifier and Type	Field and Description
protected org.broadleafcommerce.common.persistence.EntityConfiguration	entityConfig
protected AdvancedInventoryService	inventoryService

Constructor Summary

Constructors

Constructor and Description
AbstractInventoryReservationStrategy()

Method Summary

Modifier and Type	Method and Description
protected InventoryReservation	createInventoryReservation(FulfillmentLocation location, org.broadleafcommerce.core.order.domain.FulfillmentGroupItem item, Integer quantity)
boolean	favorHigherQuantityDecrement()
boolean	favorLowerQuantityDecrement()
org.broadleafcommerce.core.catalog.domain.Sku	getSkuForItem(org.broadleafcommerce.core.order.domain.FulfillmentGroupItem item) Convenience method to determine the SKU from the FulfillmentGroupItem
List<Inventory>	prioritizeInventory(List<Inventory> inventory) Takes the given list of inventory and returns a new sorted list.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.broadleafcommerce.inventory.advanced.reservation.strategy.InventoryReservationStrategy

getReservations, getType

Field Detail

inventoryService

protected AdvancedInventoryService inventoryService

entityConfig

protected org.broadleafcommerce.common.persistence.EntityConfiguration entityConfig

Constructor Detail

AbstractInventoryReservationStrategy

public AbstractInventoryReservationStrategy()

Method Detail

createInventoryReservation

protected InventoryReservation createInventoryReservation(FulfillmentLocation location,
                                                          org.broadleafcommerce.core.order.domain.FulfillmentGroupItem item,
                                                          Integer quantity)

getSkuForItem

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

Description copied from interface: InventoryReservationStrategy

Convenience method to determine the SKU from the FulfillmentGroupItem

Specified by:

getSkuForItem in interface InventoryReservationStrategy

Returns:

prioritizeInventory

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

Description copied from interface: InventoryReservationStrategy

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.

Specified by:

prioritizeInventory in interface InventoryReservationStrategy

Parameters:

inventory - the list of Inventory to prioritize

Returns:

a prioritized list of Inventory used for reserving inventory

favorHigherQuantityDecrement

public boolean favorHigherQuantityDecrement()

favorLowerQuantityDecrement

public boolean favorLowerQuantityDecrement()