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

Interface ReindexJobService<P extends ReindexJob>

  • Type Parameters:
    P - The business domain type
    All Superinterfaces:
    com.broadleafcommerce.data.tracking.core.service.MappableCrudEntityService<P>
    All Known Implementing Classes:
    NullReindexJobService
    public interface ReindexJobService<P extends ReindexJob>
extends com.broadleafcommerce.data.tracking.core.service.MappableCrudEntityService<P>
    Service API for ReindexJob

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static String AUTHOR_KEY
      Key for the author of a reindex job.
      static String NAME_KEY
      Key for the name of a reindex job.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      org.springframework.data.domain.Page<P> readAllByNameContaining​(String name, cz.jirutka.rsql.parser.ast.Node filters, org.springframework.data.domain.Pageable page, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
      Retrieves a paged list of reindex jobs filtered by the name
      org.springframework.data.domain.Page<P> readByActiveStatus​(boolean isActive, org.springframework.data.domain.Pageable pageable, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
      Returns either active or inactive ReindexJobs.

      • Methods inherited from interface com.broadleafcommerce.data.tracking.core.service.MappableCrudEntityService

        create, createAll, createAllAllowingPartialSuccess, delete, readAll, readAll, readAll, readAllByIds, readById, replace, replaceAll, replaceAllAllowingPartialSuccess, update, updateAll, updateAllAllowingPartialSuccess

    • Method Detail

      • readByActiveStatus

        org.springframework.data.domain.Page<P> readByActiveStatus​(boolean isActive,
                                                           org.springframework.data.domain.Pageable pageable,
                                                           @Nullable
                                                           com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
        Returns either active or inactive ReindexJobs. Active jobs are any jobs in the IN_PROGRESS state, while inactive jobs may be in either SUCCESS or FAILED states.
        Parameters:
        isActive - The active state of the reindex job
        pageable - The page
        context - The context
        Returns:
        A page of reindex jobs that are active or inactive.

      • readAllByNameContaining

        org.springframework.data.domain.Page<P> readAllByNameContaining​(@Nullable
                                                                String name,
                                                                @Nullable
                                                                cz.jirutka.rsql.parser.ast.Node filters,
                                                                @Nullable
                                                                org.springframework.data.domain.Pageable page,
                                                                @Nullable
                                                                com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
        Retrieves a paged list of reindex jobs filtered by the name
        Parameters:
        name - The name of the job that is being searched for
        filters - Additional filters to apply in the query. Should be EmptyNode if no additional filters should be applied.
        page - The page of results from the database
        context - The context information around sandbox and multi-tenant state
        Returns:
        Page of reindex jobs matching the name and filters.