org.broadleafcommerce.core.order.service.workflow

Class AbstractWorkflowInventoryExtensionHandler

java.lang.Object

org.broadleafcommerce.common.extension.AbstractExtensionHandler

org.broadleafcommerce.core.order.service.workflow.AbstractWorkflowInventoryExtensionHandler

All Implemented Interfaces:

ExtensionHandler, WorkflowInventoryExtensionHandler

public class AbstractWorkflowInventoryExtensionHandler
extends AbstractExtensionHandler
implements WorkflowInventoryExtensionHandler

Abstract definition of WorkflowInventoryExtensionHandler that all implementors should extend from. Defaults to ExtensionResultStatusType.NOT_HANDLED for all methods.

Author:

Phillip Verheyden (phillipuniverse)

Field Summary

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

enabled, priority

Constructor Summary

Constructors

Constructor and Description
AbstractWorkflowInventoryExtensionHandler()

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

AbstractWorkflowInventoryExtensionHandler

public AbstractWorkflowInventoryExtensionHandler()

Method Detail

checkAvailability

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

Description copied from interface: WorkflowInventoryExtensionHandler

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

Specified by:

checkAvailability in interface WorkflowInventoryExtensionHandler

Throws:

InventoryUnavailableException

See Also:

InventoryService}, CheckAvailabilityActivity}

decrementInventory

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

Description copied from interface: WorkflowInventoryExtensionHandler

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

Specified by:

decrementInventory in interface WorkflowInventoryExtensionHandler

Throws:

InventoryUnavailableException

See Also:

InventoryService}, DecrementInventoryActivity}

rollbackInventoryOperation

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

Description copied from interface: WorkflowInventoryExtensionHandler

Invoked from the DecrementInventoryRollbackHandler

Specified by:

rollbackInventoryOperation in interface WorkflowInventoryExtensionHandler

Returns:

If being implemented, ExtensionResultStatusType.HANDLED

Throws:

RollbackFailureException