org.finra.herd.service

Interface SearchIndexHelperService

All Known Implementing Classes:

SearchIndexHelperServiceImpl

public interface SearchIndexHelperService

The helper service class for the search index service.

Method Summary

Modifier and Type	Method and Description
AdminClient	getAdminClient() Gets a search index client to perform administrative actions/operations against the cluster or the indices.
Future<Void>	indexAllBusinessObjectDefinitions(SearchIndexKey searchIndexKey, String documentType) Indexes all business object definitions defined in the system.
Future<Void>	indexAllTags(SearchIndexKey searchIndexKey, String documentType) Indexes all tags defined in the system.

Method Detail

getAdminClient

AdminClient getAdminClient()

Gets a search index client to perform administrative actions/operations against the cluster or the indices.

Returns:

the search index administrative client

indexAllBusinessObjectDefinitions

Future<Void> indexAllBusinessObjectDefinitions(SearchIndexKey searchIndexKey,
                                               String documentType)

Indexes all business object definitions defined in the system.

Parameters:

searchIndexKey - the key of the search index

documentType - the document type

Returns:

result of an asynchronous computation

indexAllTags

Future<Void> indexAllTags(SearchIndexKey searchIndexKey,
                          String documentType)

Indexes all tags defined in the system.

Parameters:

searchIndexKey - the key of the search index

documentType - the document type

Returns:

result of an asynchronous computation