Package com.broadleafcommerce.search.index.catalog.service

Interface InventoryAvailabilityService

All Known Implementing Classes:
DefautlInventoryAvailabilityService
public interface InventoryAvailabilityService
This interface provides a contract that allows the Indexer to retrieve Inventory availability from an external system.
Author:
Kelly Tisdell (ktisdell)

  • Method Summary

    Modifier and Type
    Method
    Description
    List<com.broadleafcommerce.search.catalog.core.domain.ConsolidatedInventoryAvailability>
    findConsolidatedInventoryAvailability(com.broadleafcommerce.search.catalog.core.domain.Product product, com.jayway.jsonpath.DocumentContext jsonContext, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
    Reads a consolidated list of Inventory Availabilities.
    default void
    updateInventoryAvailability(com.broadleafcommerce.search.catalog.core.domain.ConsolidatedInventoryAvailability consolidatedInventoryAvailability)
    Mechanism to update the Catalog Search Index with (typically published) changes to Inventory.

  • Method Details

    • findConsolidatedInventoryAvailability

      @NonNull List<com.broadleafcommerce.search.catalog.core.domain.ConsolidatedInventoryAvailability> findConsolidatedInventoryAvailability(@NonNull com.broadleafcommerce.search.catalog.core.domain.Product product, @NonNull com.jayway.jsonpath.DocumentContext jsonContext, @NonNull com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Reads a consolidated list of Inventory Availabilities. These are typically aggregated so that they don't include quantities, nor specific warehouses or inventory locations. This is meant to indicate if inventory is available so that it should not be removed from search results.
      Parameters:
      product - for which to check availability
      jsonContext - the parsed JSON DocumentContext of the product
      contextInfo - required context info for this request, specifying the tenantId, which is required
      Returns:
      list of consolidated inventory availability across a tenant

    • updateInventoryAvailability

      default void updateInventoryAvailability(com.broadleafcommerce.search.catalog.core.domain.ConsolidatedInventoryAvailability consolidatedInventoryAvailability)
      Mechanism to update the Catalog Search Index with (typically published) changes to Inventory.
      Parameters:
      consolidatedInventoryAvailability -