Package com.broadleafcommerce.inventory.service

Interface SkuInventorySummaryService<T extends SkuInventoryAvailabilitySummary>

All Known Implementing Classes:

DefaultSkuInventorySummaryService

public interface SkuInventorySummaryService<T extends SkuInventoryAvailabilitySummary>

Service to find SkuInventory summary data (e.g. available).

Author:

Kelly Tisdell (ktisdell)

Method Summary

Modifier and Type	Method	Description
List<ConsolidatedInventoryAvailability>	readConsolidatedAvailability(Set<String> skuCodes, int minQuantityAvailable, Optional<Boolean> forShip, Optional<Boolean> forPickup, Optional<Boolean> inStore, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Returns the consolidated availability based on what is requested.
T	readInventoryAvailability(String skuRefFieldTpe, String skuReference, int minQuantityAvailable, Optional<Boolean> forShip, Optional<Boolean> forPickup, Optional<Boolean> inStore, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
List<T>	readInventoryAvailability(String skuRefFieldTpe, Map<String,Integer> skuReferenceQuantities, String inventoryLocationId, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Reads inventory summary data, typically for browsing of SKUs or Products by a particular inventory location.
List<T>	readInventoryAvailability(String skuRefFieldTpe, Map<String,Integer> skuReferenceQuantities, Optional<Boolean> forShip, Optional<Boolean> forPickup, Optional<Boolean> inStore, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Reads inventory summary data, typically for browsing of SKUs or Products.

Method Detail

readInventoryAvailability

List<T> readInventoryAvailability(@NonNull
                                  String skuRefFieldTpe,
                                  @NonNull
                                  Map<String,Integer> skuReferenceQuantities,
                                  Optional<Boolean> forShip,
                                  Optional<Boolean> forPickup,
                                  Optional<Boolean> inStore,
                                  @Nullable
                                  com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Reads inventory summary data, typically for browsing of SKUs or Products.

Parameters:

skuRefFieldTpe -

skuReferenceQuantities -

forShip -

forPickup -

inStore -

contextInfo -

Returns:

readInventoryAvailability

List<T> readInventoryAvailability(@NonNull
                                  String skuRefFieldTpe,
                                  @NonNull
                                  Map<String,Integer> skuReferenceQuantities,
                                  @NonNull
                                  String inventoryLocationId,
                                  @Nullable
                                  com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Reads inventory summary data, typically for browsing of SKUs or Products by a particular inventory location.

Parameters:

skuRefFieldTpe -

skuReferenceQuantities -

inventoryLocationId -

contextInfo -

Returns:

readInventoryAvailability

T readInventoryAvailability(@NonNull
                            String skuRefFieldTpe,
                            @NonNull
                            String skuReference,
                            int minQuantityAvailable,
                            @NonNull
                            Optional<Boolean> forShip,
                            @NonNull
                            Optional<Boolean> forPickup,
                            @NonNull
                            Optional<Boolean> inStore,
                            @Nullable
                            com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Parameters:

skuRefFieldTpe -

skuReference -

minQuantityAvailable -

forShip -

forPickup -

inStore -

contextInfo -

Returns:

readConsolidatedAvailability

List<ConsolidatedInventoryAvailability> readConsolidatedAvailability(@NonNull
                                                                     Set<String> skuCodes,
                                                                     int minQuantityAvailable,
                                                                     @NonNull
                                                                     Optional<Boolean> forShip,
                                                                     @NonNull
                                                                     Optional<Boolean> forPickup,
                                                                     @NonNull
                                                                     Optional<Boolean> inStore,
                                                                     @Nullable
                                                                     com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Returns the consolidated availability based on what is requested. This is typically used by other, aggregate services, such as Search Services, to indicate if a SKU is available for search or filtering purposes. Callers will typically set ContextInfo.setIgnoreNarrowing(boolean) to true so that all availability is returned for the tenant and all associated applications.

Parameters:

skuCodes - A Set of values associated with the skuCode field on SkuRef

minQuantityAvailable - The minimum quantity requested for all SKUs queried

forShip - Indicates if the SKU should be available for shipping

forPickup - Indicates if the SKU should be available for pickup

inStore - Indicates if the SKU should be available in store

contextInfo - The ContextInfo of the request.

Returns: