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 final String	AUTHOR_KEY	Key for the author of a reindex job.
static final String	ENABLE_PARTIAL_INDEX_WITH_FILTERS_KEY	Key for toggling a partial reindex based on applicable filters.
static final String	END_DATE_KEY	Key for the end date of a reindex job.
static final String	NAME_KEY	Key for the name of a reindex job.
static final String	START_DATE_KEY	Key for the start date of a reindex job.
static final String	TENANT_KEY	Key for the tenant of a reindex job.

Method Summary

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

Field Details

AUTHOR_KEY

static final String AUTHOR_KEY

Key for the author of a reindex job.

The default location for this is in the process state and may be retrieved with ProcessStateHolder.getAdditionalProperty(String)

See Also:

• Constant Field Values

NAME_KEY

static final String NAME_KEY

Key for the name of a reindex job.

The default location for this is in the process state and may be retrieved with ProcessStateHolder.getAdditionalProperty(String)

See Also:

• Constant Field Values

ENABLE_PARTIAL_INDEX_WITH_FILTERS_KEY

static final String ENABLE_PARTIAL_INDEX_WITH_FILTERS_KEY

Key for toggling a partial reindex based on applicable filters.

The default location for this is in the process state and may be retrieved with ProcessStateHolder.getAdditionalProperty(String)

See Also:

• Constant Field Values

START_DATE_KEY

static final String START_DATE_KEY

Key for the start date of a reindex job. This can be utilized to determine a minimum time range, filtering items to be indexed.

The default location for this is in the process state and may be retrieved with ProcessStateHolder.getAdditionalProperty(String)

See Also:

• Constant Field Values

END_DATE_KEY

static final String END_DATE_KEY

Key for the end date of a reindex job. This can be utilized to determine a maximum time range, filtering items to be indexed.

The default location for this is in the process state and may be retrieved with ProcessStateHolder.getAdditionalProperty(String)

See Also:

• Constant Field Values

TENANT_KEY

static final String TENANT_KEY

Key for the tenant of a reindex job. This can be utilized to determine a tenant ID, filtering items to be indexed.

The default location for this is in the process state and may be retrieved with ProcessStateHolder.getAdditionalProperty(String)

See Also:

• Constant Field Values

Method Details

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.