org.broadleafcommerce.core.inventory.service

Class AbstractInventoryServiceExtensionHandler

java.lang.Object

org.broadleafcommerce.common.extension.AbstractExtensionHandler

org.broadleafcommerce.core.inventory.service.AbstractInventoryServiceExtensionHandler

All Implemented Interfaces:

ExtensionHandler, InventoryServiceExtensionHandler

public abstract class AbstractInventoryServiceExtensionHandler
extends AbstractExtensionHandler
implements InventoryServiceExtensionHandler

Field Summary

Fields inherited from class org.broadleafcommerce.common.extension.AbstractExtensionHandler

enabled, priority

Constructor Summary

Constructors

Constructor and Description
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 class org.broadleafcommerce.common.extension.AbstractExtensionHandler

getPriority, isEnabled, setEnabled, setPriority

Methods inherited from class java.lang.Object

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

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

getPriority, isEnabled

Constructor Detail

AbstractInventoryServiceExtensionHandler

public AbstractInventoryServiceExtensionHandler()

Method Detail

retrieveQuantitiesAvailable

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

Description copied from interface: InventoryServiceExtensionHandler

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

Specified by:

retrieveQuantitiesAvailable in interface InventoryServiceExtensionHandler

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

See Also:

ContextualInventoryService#retrieveQuantitiesAvailable(Set, Map)}

decrementInventory

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

Description copied from interface: InventoryServiceExtensionHandler

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

Specified by:

decrementInventory in interface InventoryServiceExtensionHandler

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

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

Specified by:

incrementInventory in interface InventoryServiceExtensionHandler

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

See Also:

ContextualInventoryService#incrementInventory(Map, Map)}