Package com.broadleafcommerce.cartoperation.service.provider

Interface InventoryProvider

All Known Implementing Classes:

EmptyInventoryProvider, ExternalInventoryProvider

public interface InventoryProvider

Provides a generic API to reserve inventory during checkout.

Author:

Chad Harchar (charchar)

Method Summary

Modifier and Type	Method	Description
Map<String,List<SkuInventoryAvailabilitySummary>>	getInventorySummariesBySku(Map<String,Integer> skuCodesWithQuantity, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Gets a map of SkuInventoryAvailabilitySummaries by SKU.
boolean	isInventoryAvailable(String skuCode, int quantity, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Determines whether Inventory is available for a particular SKU.
Map<String,Boolean>	isInventoryAvailable(Map<String,Integer> skuCodesWithQuantity, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Determines whether Inventory is available for a list of SKUs.
void	reserveInventory(com.broadleafcommerce.cart.client.domain.Cart cart, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Decrement or otherwise "reserve" inventory for a cart during checkout.

Method Detail

reserveInventory

void reserveInventory(@NonNull
                      com.broadleafcommerce.cart.client.domain.Cart cart,
                      @Nullable
                      com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Decrement or otherwise "reserve" inventory for a cart during checkout.

Parameters:

cart - The cart for which to decrement inventory.

contextInfo - Context information around sandbox and multitenant state.

Throws:

InventoryUnavailableException - if inventory is not available.

isInventoryAvailable

boolean isInventoryAvailable(@NonNull
                             String skuCode,
                             int quantity,
                             @Nullable
                             com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Determines whether Inventory is available for a particular SKU.

Parameters:

skuCode - the sku code for which to check inventory availability

quantity - the quantity of the sku code that will be requested

contextInfo - context information surrounding sandboxing and multitenant state

Returns:

true if inventory is available for the SKU and quantity, false otherwise

isInventoryAvailable

Map<String,Boolean> isInventoryAvailable(@NonNull
                                               Map<String,Integer> skuCodesWithQuantity,
                                               @Nullable
                                               com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Determines whether Inventory is available for a list of SKUs.

By default, if the SKU is available for one of the SKU locations or vendors, then it's considered available overall.

Use getInventorySummariesBySku(Map, ContextInfo) for custom logic on SKU inventory availability.

Parameters:

skuCodesWithQuantity - a map of the sku codes and quantity for which to check inventory availability

contextInfo - context information surrounding sandboxing and multitenant state

Returns:

a map of the sku code with true if inventory is available for the SKU and quantity, and false otherwise

getInventorySummariesBySku

Map<String,List<SkuInventoryAvailabilitySummary>> getInventorySummariesBySku(@NonNull
                                                                                   Map<String,Integer> skuCodesWithQuantity,
                                                                                   @Nullable
                                                                                   com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Gets a map of SkuInventoryAvailabilitySummaries by SKU.

There can be multiple SkuInventoryAvailabilitySummaries for one SKU, if there are SKU inventories set up at multiple inventory locations or vendors.

This is useful for custom SKU inventory availability logic.

Parameters:

skuCodesWithQuantity - a map of the sku codes and quantity for which to check inventory availability

contextInfo - context information surrounding sandboxing and multitenant state

Returns:

a map of SkuInventoryAvailabilitySummaries by SKU