Package 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	Description
AbstractInventoryServiceExtensionHandler()

Method Summary

Modifier and Type	Method	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	isBlockingAvailabilityOfProduct(Product baseProduct, Product product, ExtensionResultHolder<Boolean> holder)	This determines if the missing quantity is critical (blocking) to be added to the cart Usually invoked via the UncacheableDataProcessor to determine the availability of product.
ExtensionResultStatusType	isProductBundleAvailable(Product product, int quantity, ExtensionResultHolder<Boolean> holder)	Usually invoked via the AdvancedProduct to determine the availability of product bundle.
ExtensionResultStatusType	reconcileChangeOrderInventory(Map<Sku,Integer> decrementSkuQuantities, Map<Sku,Integer> incrementSkuQuantities, Map<String,Object> context)	Usually invoked via the OMS ReconcileInventoryChangeOrderActivity to determine how to handle a change order.
ExtensionResultStatusType	retrieveQuantitiesAvailable(Collection<Sku> skus, Map<String,Object> context, ExtensionResultHolder<Map<Sku,Integer>> result)	Usually invoked within the CheckAddAvailabilityActivity 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 Details

AbstractInventoryServiceExtensionHandler

public AbstractInventoryServiceExtensionHandler()

Method Details

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 CheckAddAvailabilityActivity 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

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

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

reconcileChangeOrderInventory

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

Description copied from interface: InventoryServiceExtensionHandler

Usually invoked via the OMS ReconcileInventoryChangeOrderActivity to determine how to handle a change order.

Specified by:

reconcileChangeOrderInventory in interface InventoryServiceExtensionHandler

Returns:

Throws:

InventoryUnavailableException

isProductBundleAvailable

public ExtensionResultStatusType isProductBundleAvailable(Product product,
 int quantity,
 ExtensionResultHolder<Boolean> holder)

Description copied from interface: InventoryServiceExtensionHandler

Usually invoked via the AdvancedProduct to determine the availability of product bundle.

Specified by:

isProductBundleAvailable in interface InventoryServiceExtensionHandler

Parameters:

product - contains Product

isBlockingAvailabilityOfProduct

public ExtensionResultStatusType isBlockingAvailabilityOfProduct(Product baseProduct,
 Product product,
 ExtensionResultHolder<Boolean> holder)

Description copied from interface: InventoryServiceExtensionHandler

This determines if the missing quantity is critical (blocking) to be added to the cart Usually invoked via the UncacheableDataProcessor to determine the availability of product.

Specified by:

isBlockingAvailabilityOfProduct in interface InventoryServiceExtensionHandler

Parameters:

baseProduct - base product with add-ons

product - one of the add-on products of the base product

holder - holder for result

Returns:

ExtensionResultStatusType status after operation