org.broadleafcommerce.core.inventory.service

Interface InventoryServiceExtensionHandler

All Superinterfaces:

ExtensionHandler

All Known Implementing Classes:

AbstractInventoryServiceExtensionHandler

public interface InventoryServiceExtensionHandler
extends ExtensionHandler

Marker interface to dictate the overridden methods within ContextualInventoryService. Usually, implementers will want to only override the ContextualInventoryService methods rather than all of the methods included in InventoryService and so you will extend from AbstractInventoryServiceExtensionHandler.

Author:

Phillip Verheyden (phillipuniverse)

See Also:

ContextualInventoryService}, AbstractInventoryServiceExtensionHandler}

Method Summary

Methods

Modifier and Type	Method and Description
ExtensionResultStatusType	decrementInventory(Map<Sku,Integer> skuQuantities, Map<String,Object> context) Usually invoked within the DecrementInventoryActivity to decrement inventory for the Skus that are in skuQuantities
ExtensionResultStatusType	incrementInventory(Map<Sku,Integer> skuQuantities, Map<String,Object> context)
ExtensionResultStatusType	retrieveQuantitiesAvailable(Collection<Sku> skus, Map<String,Object> context, ExtensionResultHolder<Map<Sku,Integer>> result) Usually invoked within the CheckAvailabilityActivity to retrieve the quantity that is available for the given skus.

Methods inherited from interface org.broadleafcommerce.common.extension.ExtensionHandler

getPriority, isEnabled

Method Detail

retrieveQuantitiesAvailable

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

Usually invoked within the CheckAvailabilityActivity to retrieve the quantity that is available for the given skus.

Parameters:

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

See Also:

ContextualInventoryService#retrieveQuantitiesAvailable(Set, Map)}

decrementInventory

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

Usually invoked within the DecrementInventoryActivity to decrement inventory for the Skus that are in skuQuantities

Parameters:

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

Throws:

InventoryUnavailableException

See Also:

ContextualInventoryService#decrementInventory(Map, Map)}

incrementInventory

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

Parameters:

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

See Also:

ContextualInventoryService#incrementInventory(Map, Map)}