Package com.broadleafcommerce.search.index.core.service

Interface IndexerSearchService<T extends com.broadleafcommerce.search.api.domain.FieldDefinition>

All Known Implementing Classes:
DefaultIndexerSearchService
public interface IndexerSearchService<T extends com.broadleafcommerce.search.api.domain.FieldDefinition>
Service used by the search indexer to interact with the search service.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    clearCache(com.broadleafcommerce.search.api.type.IndexableType indexableType)
    Clear any cached fields for the indexable type.
    List<T>
    readFieldsByIndexable(com.broadleafcommerce.search.api.domain.Indexable<?> indexable)
    Returns a list of Search fields by Indexable.
    List<T>
    readFieldsByIndexable(com.broadleafcommerce.search.api.domain.Indexable<?> indexable, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
    Returns a list of Search fields by Indexable.
    List<T>
    readFieldsByIndexableType(com.broadleafcommerce.search.api.type.IndexableType indexableType)
    Deprecated.
    List<T>
    readFieldsByIndexableType(com.broadleafcommerce.search.api.type.IndexableType indexableType, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
    Returns a list of Search fields by IndexableType and ContextInfo, if applicable.

  • Method Details

    • readFieldsByIndexableType

      @Deprecated List<T> readFieldsByIndexableType(com.broadleafcommerce.search.api.type.IndexableType indexableType)
      Deprecated.
      Returns a list of Search fields by IndexableType
      Parameters:
      indexableType - The indexable type
      Returns:
      Search fields associated with the IndexableType

    • readFieldsByIndexableType

      @NonNull List<T> readFieldsByIndexableType(com.broadleafcommerce.search.api.type.IndexableType indexableType, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Returns a list of Search fields by IndexableType and ContextInfo, if applicable.
      Parameters:
      indexableType - The indexable type
      Returns:
      Search fields associated with the IndexableType

    • readFieldsByIndexable

      @NonNull List<T> readFieldsByIndexable(com.broadleafcommerce.search.api.domain.Indexable<?> indexable)
      Returns a list of Search fields by Indexable. Indexable is used to determine the IndexableType and, optionally, the Context Info (most importantly, the tenant based on the ContextStateAware, if applicable.
      Parameters:
      indexable -
      Returns:

    • readFieldsByIndexable

      @NonNull List<T> readFieldsByIndexable(com.broadleafcommerce.search.api.domain.Indexable<?> indexable, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Returns a list of Search fields by Indexable. Indexable is used to determine the IndexableType and, optionally, the Context Info (most importantly, the tenant based on the ContextStateAware, if applicable.
      Parameters:
      indexable -
      contextInfo -
      Returns:

    • clearCache

      void clearCache(com.broadleafcommerce.search.api.type.IndexableType indexableType)
      Clear any cached fields for the indexable type.
      Parameters:
      indexableType - The indexable type to clear