Package com.broadleafcommerce.inventory.service.messaging.fulfillments

Class FulfillmentCancelledInventoryAdjustmentListener

java.lang.Object

com.broadleafcommerce.inventory.service.messaging.AbstractInventoryAdjustmentListener

com.broadleafcommerce.inventory.service.messaging.fulfillments.AbstractFulfillmentStatusChangeInventoryAdjustmentListener

com.broadleafcommerce.inventory.service.messaging.fulfillments.FulfillmentCancelledInventoryAdjustmentListener

@DataRouteByKey("inventory")
public class FulfillmentCancelledInventoryAdjustmentListener
extends AbstractFulfillmentStatusChangeInventoryAdjustmentListener

Listens for cancelled fulfillments to create DefaultInventoryTransactionType.CANCELLED InventoryTransactions and update SkuInventory.

Nested Class Summary

Nested classes/interfaces inherited from class com.broadleafcommerce.inventory.service.messaging.fulfillments.AbstractFulfillmentStatusChangeInventoryAdjustmentListener

AbstractFulfillmentStatusChangeInventoryAdjustmentListener.OrderFulfillmentItem, AbstractFulfillmentStatusChangeInventoryAdjustmentListener.OrderItem

Field Summary

Fields

Modifier and Type	Field	Description
protected static String	CANCELLED_STATUS

Fields inherited from class com.broadleafcommerce.inventory.service.messaging.fulfillments.AbstractFulfillmentStatusChangeInventoryAdjustmentListener

FULFILLMENT_ID_PATH, FULFILLMENT_ITEMS_PATH, FULFILLMENT_STATUS_PATH, NEVER_RESERVATION_STRATEGY, ORDER_ITEMS_PATH

Fields inherited from class com.broadleafcommerce.inventory.service.messaging.AbstractInventoryAdjustmentListener

APPLICATION_ID_PATH, TENANT_ID_PATH

Constructor Summary

Constructors

Constructor	Description
FulfillmentCancelledInventoryAdjustmentListener(com.broadleafcommerce.common.messaging.service.IdempotentMessageConsumptionService idempotentConsumptionService, com.broadleafcommerce.common.extension.TypeFactory typeFactory, SkuInventoryService<SkuInventory> skuInventoryService)

Method Summary

Modifier and Type	Method	Description
protected String	getValidFulfillmentStatus()	Supplies the valid fulfillment status which can be handled.
void	listen(org.springframework.messaging.Message<String> message)
protected void	performInventoryAdjustment(SkuInventoryAdjustmentRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Execute the required inventory adjustment for the status change.

Methods inherited from class com.broadleafcommerce.inventory.service.messaging.fulfillments.AbstractFulfillmentStatusChangeInventoryAdjustmentListener

buildRequestedItems, buildSkuInventoryAdjustmentRequest, process

Methods inherited from class com.broadleafcommerce.inventory.service.messaging.AbstractInventoryAdjustmentListener

buildContextInfo, buildContextInfo, getDocumentContext, getIdempotentConsumptionService, getSkuInventoryService, getSkuReferenceFieldType, getTypeFactory

Methods inherited from class java.lang.Object

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

Field Detail

CANCELLED_STATUS

protected static final String CANCELLED_STATUS

See Also:

Constant Field Values

Constructor Detail

FulfillmentCancelledInventoryAdjustmentListener

public FulfillmentCancelledInventoryAdjustmentListener(com.broadleafcommerce.common.messaging.service.IdempotentMessageConsumptionService idempotentConsumptionService,
                                                       com.broadleafcommerce.common.extension.TypeFactory typeFactory,
                                                       SkuInventoryService<SkuInventory> skuInventoryService)

Method Detail

listen

@StreamListener("inventoryFulfillmentCancelledInput")
public void listen(org.springframework.messaging.Message<String> message)

getValidFulfillmentStatus

protected String getValidFulfillmentStatus()

Description copied from class: AbstractFulfillmentStatusChangeInventoryAdjustmentListener

Supplies the valid fulfillment status which can be handled.

Specified by:

getValidFulfillmentStatus in class AbstractFulfillmentStatusChangeInventoryAdjustmentListener

Returns:

the valid fulfillment status which can be handled

performInventoryAdjustment

protected void performInventoryAdjustment(SkuInventoryAdjustmentRequest request,
                                          com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
                                   throws InventoryNotReservedException,
                                          InventoryUnavailableException

Description copied from class: AbstractFulfillmentStatusChangeInventoryAdjustmentListener

Execute the required inventory adjustment for the status change.

Specified by:

performInventoryAdjustment in class AbstractFulfillmentStatusChangeInventoryAdjustmentListener

Parameters:

request - the request to adjust inventory

contextInfo - context information surrounding sandboxing and multitenant state

Throws:

InventoryNotReservedException - if inventory was not already reserved

InventoryUnavailableException - if inventory could not be decremented