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

Interface ReindexDelegationService

  • All Known Implementing Classes:
    DefaultReindexDelegationService
    public interface ReindexDelegationService
    Generic intermediary reindex implementation that delegates to implementation specific index functionality.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void performFullReindex​(com.broadleafcommerce.search.api.type.IndexableType type)
      Performs a full reindex on a specific type.
      void performFullReindex​(com.broadleafcommerce.search.api.type.IndexableType type, Map<String,​Serializable> properties)
      Performs a full reindex on a specific type.
      void reindex​(com.broadleafcommerce.search.api.domain.Indexable<?> indexable)
      Indexes a single Indexable immediately to the primary collection.
      void reindex​(List<? extends com.broadleafcommerce.search.api.domain.Indexable<?>> indexables)
      Indexes multiple Indexables immediately to the primary collection.

    • Method Detail

      • performFullReindex

        void performFullReindex​(com.broadleafcommerce.search.api.type.IndexableType type)
                 throws com.broadleafcommerce.search.api.SearchIndexException
        Performs a full reindex on a specific type.
        Parameters:
        type - The type to reindex
        Throws:
        com.broadleafcommerce.search.api.SearchIndexException - If an error occurs during the reindex process

      • performFullReindex

        void performFullReindex​(com.broadleafcommerce.search.api.type.IndexableType type,
                        Map<String,​Serializable> properties)
                 throws com.broadleafcommerce.search.api.SearchIndexException
        Performs a full reindex on a specific type.

        Allows additional properties to be passed and used in the reindex process. These properties are accessible via ProcessStateHolder.getAdditionalProperties()

        Parameters:
        type - The indexable type
        properties - Properties available during the reindex process
        Throws:
        com.broadleafcommerce.search.api.SearchIndexException - If an error occurs during the reindex process
        See Also:
        ProcessStateHolder

      • reindex

        void reindex​(List<? extends com.broadleafcommerce.search.api.domain.Indexable<?>> indexables)
      throws com.broadleafcommerce.search.api.SearchIndexException
        Indexes multiple Indexables immediately to the primary collection.
        Parameters:
        indexables - The indexables to index.
        Throws:
        com.broadleafcommerce.search.api.SearchIndexException - If an error occurs during the reindex process

      • reindex

        void reindex​(com.broadleafcommerce.search.api.domain.Indexable<?> indexable)
      throws com.broadleafcommerce.search.api.SearchIndexException
        Indexes a single Indexable immediately to the primary collection.
        Parameters:
        indexable - The indexable to index.
        Throws:
        com.broadleafcommerce.search.api.SearchIndexException - If an error occurs during the reindex process