org.broadleafcommerce.core.inventory.service

Interface ContextualInventoryService

All Superinterfaces:

InventoryService

All Known Implementing Classes:

InventoryServiceImpl

public interface ContextualInventoryService
extends InventoryService

Provides the same methods from InventoryService but with optional, additional context information. This context can then be passed on to an InventoryServiceExtensionHandler

Author:

Phillip Verheyden (phillipuniverse)

See Also:

InventoryService}, InventoryServiceExtensionHandler}, CheckAvailabilityActivity}, DecrementInventoryActivity}

Field Summary

Fields

Modifier and Type	Field and Description
static String	CHANGE_ORDER_KEY Used as a key in the context map methods below.
static String	ORDER_KEY Used as a key in the context map methods below.
static String	ROLLBACK_STATE_KEY Used as a key in the context map methods below.

Method Summary

Modifier and Type	Method and Description
Map<Sku,Integer>	buildSkuInventoryMap(Order order) Convenience method to build the sku inventory map given an Order
void	decrementInventory(Map<Sku,Integer> skuQuantities, Map<String,Object> context) Usually invoked from DecrementInventoryActivity
void	decrementInventory(Sku sku, int quantity, Map<String,Object> context) Pass through for decrementInventory(Map, Map)
void	incrementInventory(Map<Sku,Integer> skuQuantities, Map<String,Object> context) Callers that invoke this method directly should check for a ROLLBACK_STATE_KEY in the given context.
void	incrementInventory(Sku sku, int quantity, Map<String,Object> context)
boolean	isAvailable(Sku sku, int quantity, Map<String,Object> context)
void	reconcileChangeOrderInventory(Map<Sku,Integer> decrementSkuQuantities, Map<Sku,Integer> incrementSkuQuantities, Map<String,Object> context) Explicit method that defines exactly how to reconcile inventory in the event of a change order.
Map<Sku,Integer>	retrieveQuantitiesAvailable(Collection<Sku> skus, Map<String,Object> context)
Integer	retrieveQuantityAvailable(Sku sku, Map<String,Object> context)

Methods inherited from interface org.broadleafcommerce.core.inventory.service.InventoryService

checkBasicAvailablility, decrementInventory, decrementInventory, incrementInventory, incrementInventory, isAvailable, retrieveQuantitiesAvailable, retrieveQuantityAvailable

Field Detail

ORDER_KEY

static final String ORDER_KEY

Used as a key in the context map methods below. This is used for the current order that should be used to evaluate the methods below

See Also:

Constant Field Values

CHANGE_ORDER_KEY

static final String CHANGE_ORDER_KEY

Used as a key in the context map methods below. This is used for the newly created change order that should be used in evaluation of the reconcileChangeOrderInventory(java.util.Map, java.util.Map, java.util.Map) below

See Also:

Constant Field Values

ROLLBACK_STATE_KEY

static final String ROLLBACK_STATE_KEY

Used as a key in the context map methods below. This key is normally populated from the DecrementInventoryActivity and is utilized in the DecrementInventoryRollbackHandler. This can be cast to a Map and is designed such that when it is used, non-read operations (decrement and increment) can add what actually happened so that it can be reversed.

See Also:

Constant Field Values

Method Detail

retrieveQuantityAvailable

Integer retrieveQuantityAvailable(Sku sku,
                                  Map<String,Object> context)

Parameters:

context - can be null. If not null, this should at least contain the #CART_CONTEXT_KEY

See Also:

#retrieveQuantitiesAvailable(Collection, Map)}

retrieveQuantitiesAvailable

Map<Sku,Integer> retrieveQuantitiesAvailable(Collection<Sku> skus,
                                             Map<String,Object> context)

Parameters:

context - can be null. If not null, this should at least contain the #CART_CONTEXT_KEY

See Also:

#retrieveQuantitiesAvailable(Collection)}

isAvailable

boolean isAvailable(Sku sku,
                    int quantity,
                    Map<String,Object> context)

Parameters:

context - can be null. If not null, this should at least contain the #CART_CONTEXT_KEY

See Also:

#isAvailable(Sku, int)}

decrementInventory

void decrementInventory(Sku sku,
                        int quantity,
                        Map<String,Object> context)
                 throws InventoryUnavailableException

Pass through for decrementInventory(Map, Map)

Throws:

InventoryUnavailableException

See Also:

#decrementInventory(Map, Map)}

decrementInventory

void decrementInventory(Map<Sku,Integer> skuQuantities,
                        Map<String,Object> context)
                 throws InventoryUnavailableException

Usually invoked from DecrementInventoryActivity

Callers that invoke this method directly should check the given context object for a ROLLBACK_STATE_KEY. This will contain information about what actually happened in terms of decrementing inventory. For implementers of this interface

Implementers of this method (explicitly those that are utilizing the InventoryServiceExtensionHandler) should populate a ROLLBACK_STATE_KEY within the given context in order to communicate back to the caller what actually happened while decrementing inventory so that it can be undone later

Parameters:

context - can be null. If not null, this should at least contain the ORDER_KEY and/or the ROLLBACK_STATE_KEY

Throws:

InventoryUnavailableException

See Also:

#decrementInventory(Map)}

incrementInventory

void incrementInventory(Sku sku,
                        int quantity,
                        Map<String,Object> context)

See Also:

#incrementInventory(Map, Map)}

incrementInventory

void incrementInventory(Map<Sku,Integer> skuQuantities,
                        Map<String,Object> context)

Callers that invoke this method directly should check for a ROLLBACK_STATE_KEY in the given context. This will contain information about what actually happened in terms of decrementing inventory

Implementers of this method (explicitly those that are utilizing the InventoryServiceExtensionHandler) should populate a ROLLBACK_STATE_KEY within the given context in order to communicate back to the caller what actually happened while decrementing inventory so that it can be undone later

Parameters:

context - can be null. If not null, this should at least contain the ROLLBACK_STATE_KEY

See Also:

#incrementInventory(Map)}

reconcileChangeOrderInventory

void reconcileChangeOrderInventory(Map<Sku,Integer> decrementSkuQuantities,
                                   Map<Sku,Integer> incrementSkuQuantities,
                                   Map<String,Object> context)
                            throws InventoryUnavailableException

Explicit method that defines exactly how to reconcile inventory in the event of a change order. This usually occurs after an order has been submitted and any inventory changes and reservations/holds have already been committed.

Implementers of this method should assume that the quantities passed in are deltas and represent the changed quantities (either incremented or decremented) from the old order to the newly changed order.

Parameters:

decrementSkuQuantities - - the delta change of sku quantities to decrement

incrementSkuQuantities - - the delta change of sku quantities to increment

context -

Throws:

InventoryUnavailableException

buildSkuInventoryMap

Map<Sku,Integer> buildSkuInventoryMap(Order order)

Convenience method to build the sku inventory map given an Order

Parameters:

order -

Returns:

a SKU to Quantity map represented by the items and quantities on the fulfillment group and fulfillment group items in the order.