Package com.broadleafcommerce.inventory.service.messaging.returns

Class ReturnConfirmedInventoryAdjustmentListener

java.lang.Object

com.broadleafcommerce.inventory.service.messaging.AbstractInventoryAdjustmentListener

com.broadleafcommerce.inventory.service.messaging.returns.ReturnConfirmedInventoryAdjustmentListener

@DataRouteByKey("inventory")
public class ReturnConfirmedInventoryAdjustmentListener
extends AbstractInventoryAdjustmentListener

Listens for return confirmations to create DefaultInventoryTransactionType.RETURNED InventoryTransactions and update SkuInventory.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ReturnConfirmedInventoryAdjustmentListener.ConfirmReturnItemRequest	Confirm return item request fields relevant for adjusting inventory.

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

AbstractInventoryAdjustmentListener.OrderFulfillment, AbstractInventoryAdjustmentListener.OrderFulfillmentItem, AbstractInventoryAdjustmentListener.OrderItem

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	CONFIRM_RETURN_REQUEST_ITEMS_PATH
protected static final String	FULFILLMENTS_PATH
protected static final String	ORDER_ITEMS_PATH
protected static final String	RETURN_AUTH_ID_PATH

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

APPLICATION_ID_PATH, INVENTORY_SERIALIZATION_VALUE, TENANT_ID_PATH

Constructor Summary

Constructors

Constructor	Description
ReturnConfirmedInventoryAdjustmentListener(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	buildSerializedSku(AbstractInventoryAdjustmentListener.OrderItem orderItem)	Builds a sku with an appended serialization value parameter
protected SkuInventoryAdjustmentRequestGroup	buildSkuInventoryAdjustmentGroup(List<AbstractInventoryAdjustmentListener.OrderFulfillment> fulfillments, Map<String,List<ReturnConfirmedInventoryAdjustmentListener.ConfirmReturnItemRequest>> returnItemRequestsByFulfillmentItemId, Map<String,AbstractInventoryAdjustmentListener.OrderItem> orderItemsById)
protected SkuInventoryAdjustmentRequestItem	buildSkuInventoryAdjustmentItem(AbstractInventoryAdjustmentListener.OrderFulfillmentItem fulfillmentItem, AbstractInventoryAdjustmentListener.OrderItem orderItem, int quantityReturned)	Builds a SkuInventoryAdjustmentRequestItem with data from provided objects.
protected SkuInventoryAdjustmentRequest	buildSkuInventoryAdjustmentRequest(@NonNull com.jayway.jsonpath.DocumentContext jsonContext, @NonNull com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Builds the SkuInventoryAdjustmentRequest based on the return confirmations and fulfillment info in the status change message.
protected boolean	containsNewlyReturnedItems(AbstractInventoryAdjustmentListener.OrderFulfillment fulfillment, Map<String,List<ReturnConfirmedInventoryAdjustmentListener.ConfirmReturnItemRequest>> returnItemRequestsByFulfillmentItemId)
protected String	getInventorySerializationValue(AbstractInventoryAdjustmentListener.OrderItem orderItem)	Hook point to get the serialization value of an order item
List<AbstractInventoryAdjustmentListener.OrderItem>	getOrderItemsIncludingDependents(@NonNull com.jayway.jsonpath.DocumentContext jsonContext)	Gets a list of OrderItems along with their dependent items.
protected boolean	isSerialized(AbstractInventoryAdjustmentListener.OrderItem orderItem)	Determines whether the order item has a serialized sku inventory object
void	listen(org.springframework.messaging.Message<String> message)
void	process(@NonNull org.springframework.messaging.Message<String> message)	Extracts the message, creates InventoryTransactions and updates SkuInventory.

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 Details

RETURN_AUTH_ID_PATH

protected static final String RETURN_AUTH_ID_PATH

See Also:

• Constant Field Values

CONFIRM_RETURN_REQUEST_ITEMS_PATH

protected static final String CONFIRM_RETURN_REQUEST_ITEMS_PATH

See Also:

• Constant Field Values

FULFILLMENTS_PATH

protected static final String FULFILLMENTS_PATH

See Also:

• Constant Field Values

ORDER_ITEMS_PATH

protected static final String ORDER_ITEMS_PATH

See Also:

• Constant Field Values

Constructor Details

ReturnConfirmedInventoryAdjustmentListener

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

Method Details

listen

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

process

public void process(@NonNull
 @NonNull org.springframework.messaging.Message<String> message)

Extracts the message, creates InventoryTransactions and updates SkuInventory.

Parameters:

message - The return confirmation event message

buildSkuInventoryAdjustmentRequest

protected SkuInventoryAdjustmentRequest buildSkuInventoryAdjustmentRequest(@NonNull
 @NonNull com.jayway.jsonpath.DocumentContext jsonContext,
 @NonNull
 @NonNull com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Builds the SkuInventoryAdjustmentRequest based on the return confirmations and fulfillment info in the status change message.

Parameters:

jsonContext - a DocumentContext representation of the fulfillment message payload

contextInfo - Context information around sandbox and multitenant state.

Returns:

The SkuInventoryAdjustmentRequest based on the fulfillment info in the status change message.

getOrderItemsIncludingDependents

public List<AbstractInventoryAdjustmentListener.OrderItem> getOrderItemsIncludingDependents(@NonNull
 @NonNull com.jayway.jsonpath.DocumentContext jsonContext)

Gets a list of OrderItems along with their dependent items.

containsNewlyReturnedItems

protected boolean containsNewlyReturnedItems(AbstractInventoryAdjustmentListener.OrderFulfillment fulfillment,
 Map<String,List<ReturnConfirmedInventoryAdjustmentListener.ConfirmReturnItemRequest>> returnItemRequestsByFulfillmentItemId)

buildSkuInventoryAdjustmentGroup

protected SkuInventoryAdjustmentRequestGroup buildSkuInventoryAdjustmentGroup(List<AbstractInventoryAdjustmentListener.OrderFulfillment> fulfillments,
 Map<String,List<ReturnConfirmedInventoryAdjustmentListener.ConfirmReturnItemRequest>> returnItemRequestsByFulfillmentItemId,
 Map<String,AbstractInventoryAdjustmentListener.OrderItem> orderItemsById)

buildSkuInventoryAdjustmentItem

protected SkuInventoryAdjustmentRequestItem buildSkuInventoryAdjustmentItem(AbstractInventoryAdjustmentListener.OrderFulfillmentItem fulfillmentItem,
 AbstractInventoryAdjustmentListener.OrderItem orderItem,
 int quantityReturned)

Builds a SkuInventoryAdjustmentRequestItem with data from provided objects.

Parameters:

fulfillmentItem - the fulfillment item

orderItem - the order item

quantityReturned - the quantity to be returned of this item

Returns:

the built sku inventory adjustment item

isSerialized

protected boolean isSerialized(AbstractInventoryAdjustmentListener.OrderItem orderItem)

Determines whether the order item has a serialized sku inventory object

Parameters:

orderItem - the order item

Returns:

whether the order item has a serialized sku inventory object

buildSerializedSku

protected String buildSerializedSku(AbstractInventoryAdjustmentListener.OrderItem orderItem)

Builds a sku with an appended serialization value parameter

Parameters:

orderItem - order item to access values from

Returns:

sku with an appended serialization value parameter

getInventorySerializationValue

@Nullable
protected String getInventorySerializationValue(AbstractInventoryAdjustmentListener.OrderItem orderItem)

Hook point to get the serialization value of an order item

By default, accesses a respective entry inside AbstractInventoryAdjustmentListener.OrderItem.getInternalAttributes().

Parameters:

orderItem - the order item

Returns:

the serialization value