org.broadleafcommerce.core.order.service.workflow

Interface WorkflowInventoryExtensionHandler

All Superinterfaces:

ExtensionHandler

All Known Implementing Classes:

AbstractWorkflowInventoryExtensionHandler

public interface WorkflowInventoryExtensionHandler
extends ExtensionHandler

Extension handler dealing with inventory operations within different workflows. Usually all methods are implemented for a particular inventory provider

Author:

Phillip Verheyden (phillipuniverse)

Method Summary

Methods

Modifier and Type	Method and Description
ExtensionResultStatusType	checkAvailability(Sku sku, Integer requestedQuantity, ProcessContext<CartOperationRequest> context) Invoked during the blAddItemWorkflow and blUpdateItemWorkflow within the CheckAvailabilityActivity if it is hooked up.
ExtensionResultStatusType	decrementInventory(Map<Sku,Integer> skuQuantities, ProcessContext<CheckoutSeed> context, Map<String,Object> rollbackState) Invoked during the blCheckoutWorkflow ExtensionResultStatusType.NOT_HANDLED then the default inventory system in the framework will be checked.
ExtensionResultStatusType	rollbackInventoryOperation(ProcessContext<CheckoutSeed> context, Map<String,Object> rollbackState) Invoked from the DecrementInventoryRollbackHandler

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

getPriority, isEnabled

Method Detail

checkAvailability

ExtensionResultStatusType checkAvailability(Sku sku,
                                          Integer requestedQuantity,
                                          ProcessContext<CartOperationRequest> context)
                                            throws InventoryUnavailableException

Invoked during the blAddItemWorkflow and blUpdateItemWorkflow within the CheckAvailabilityActivity if it is hooked up. If this returns ExtensionResultStatusType.NOT_HANDLED then the default inventory system in the framework will be checked. Therefore, if you decide to implement this method then you MUST return ExtensionResultStatusType.HANDLED, even if the given Sku's Sku.getInventoryType() does not return InventoryType.CHECK_QUANTITY

Throws:

InventoryUnavailableException

See Also:

InventoryService}, CheckAvailabilityActivity}

decrementInventory

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

Invoked during the blCheckoutWorkflow ExtensionResultStatusType.NOT_HANDLED then the default inventory system in the framework will be checked. Therefore, if you decide to implement this method then you MUST return ExtensionResultStatusType.HANDLED, even if the given Sku's Sku.getInventoryType() does not return InventoryType.CHECK_QUANTITY

Throws:

{@link - InventoryUnavailableException} if there is not enough inventory available for any of the Skus within skuQuantities

InventoryUnavailableException

See Also:

InventoryService}, DecrementInventoryActivity}

rollbackInventoryOperation

ExtensionResultStatusType rollbackInventoryOperation(ProcessContext<CheckoutSeed> context,
                                                   Map<String,Object> rollbackState)
                                                     throws RollbackFailureException

Invoked from the DecrementInventoryRollbackHandler

Parameters:

inventoryToIncrement - - inventory that was previously decremented and now should be incremented

incrementedInventory - - inventory that was previously incremented and now should be decremented

orderId -

Returns:

If being implemented, ExtensionResultStatusType.HANDLED

Throws:

{@link - RollbackFailureException} if there was a problem rolling back the inventory operation

RollbackFailureException