Package de.hybris.platform.searchservices.indexer.service

Interface SnIndexerService

All Known Implementing Classes:

DefaultSnIndexerService

public interface SnIndexerService

Service for indexer operations.

Method Summary

Modifier and Type	Method	Description
SnIndexerRequest	createFullIndexerRequest(java.lang.String indexTypeId, SnIndexerItemSource indexerItemSource)	Creates a full indexer request.
SnIndexerRequest	createFullIndexerRequest(java.lang.String indexTypeId, SnIndexerItemSource indexerItemSource, SnProgressTracker progressTracker)	Creates a full indexer request.
SnIndexerRequest	createIncrementalIndexerRequest(java.lang.String indexTypeId, java.util.List<SnIndexerItemSourceOperation> indexerItemSourceOperations)	Creates an incremental indexer request.
SnIndexerRequest	createIncrementalIndexerRequest(java.lang.String indexTypeId, java.util.List<SnIndexerItemSourceOperation> indexerItemSourceOperations, SnProgressTracker progressTracker)	Creates an incremental indexer request.
SnIndexerItemSource	createItemSource(AbstractSnIndexerItemSourceModel itemSource, java.util.Map<java.lang.String,java.lang.Object> parameters)	Creates a new instance of SnIndexerItemSource.
SnIndexerItemSourceOperation	createItemSourceOperation(SnIndexerItemSourceOperationModel itemSourceOperation, java.util.Map<java.lang.String,java.lang.Object> parameters)	Creates a new instance of SnIndexerItemSourceOperation.
SnIndexerResponse	index(SnIndexerRequest indexerRequest)	Starts a new indexer operation.

Method Detail

createItemSource

SnIndexerItemSource createItemSource(AbstractSnIndexerItemSourceModel itemSource,
                                     java.util.Map<java.lang.String,java.lang.Object> parameters)
                              throws SnIndexerException

Creates a new instance of SnIndexerItemSource.

Parameters:

itemSource - - the item source

parameters - - the parameters

Returns:

the new instance of SnIndexerItemSource

Throws:

SnIndexerException - if an error occurs

createItemSourceOperation

SnIndexerItemSourceOperation createItemSourceOperation(SnIndexerItemSourceOperationModel itemSourceOperation,
                                                       java.util.Map<java.lang.String,java.lang.Object> parameters)
                                                throws SnIndexerException

Creates a new instance of SnIndexerItemSourceOperation.

Parameters:

itemSourceOperation - - the item source operation

parameters - - the parameters

Returns:

the new instance of SnIndexerItemSourceOperation

Throws:

SnIndexerException - if an error occurs

createFullIndexerRequest

SnIndexerRequest createFullIndexerRequest(java.lang.String indexTypeId,
                                          SnIndexerItemSource indexerItemSource)
                                   throws SnIndexerException

Creates a full indexer request.

Parameters:

indexTypeId - - the index type id

indexerItemSource - - the indexer item source

Returns:

the new indexer request

Throws:

SnIndexerException - if an error occurs

createFullIndexerRequest

SnIndexerRequest createFullIndexerRequest(java.lang.String indexTypeId,
                                          SnIndexerItemSource indexerItemSource,
                                          SnProgressTracker progressTracker)
                                   throws SnIndexerException

Creates a full indexer request.

Parameters:

indexTypeId - - the index type id

indexerItemSource - - the indexer item source

progressTracker - - the progress tracker

Returns:

the new indexer request

Throws:

SnIndexerException - if an error occurs

createIncrementalIndexerRequest

SnIndexerRequest createIncrementalIndexerRequest(java.lang.String indexTypeId,
                                                 java.util.List<SnIndexerItemSourceOperation> indexerItemSourceOperations)
                                          throws SnIndexerException

Creates an incremental indexer request.

Parameters:

indexTypeId - - the index type id

indexerOperationType - - the indexer operation type

indexerItemSourceOperations - - the indexer item source operations

Returns:

the new indexer request

Throws:

SnIndexerException - if an error occurs

createIncrementalIndexerRequest

SnIndexerRequest createIncrementalIndexerRequest(java.lang.String indexTypeId,
                                                 java.util.List<SnIndexerItemSourceOperation> indexerItemSourceOperations,
                                                 SnProgressTracker progressTracker)
                                          throws SnIndexerException

Creates an incremental indexer request.

Parameters:

indexTypeId - - the index type id

indexerOperationType - - the indexer operation type

indexerItemSourceOperations - - the indexer item source operations

progressTracker - - the progress tracker

Returns:

the new indexer request

Throws:

SnIndexerException - if an error occurs

index

SnIndexerResponse index(SnIndexerRequest indexerRequest)
                 throws SnIndexerException

Starts a new indexer operation.

Parameters:

indexerRequest - - the indexer request

Returns:

the indexer response

Throws:

SnIndexerException - if an error occurs