org.finra.herd.service

Interface SearchIndexService

All Known Implementing Classes:

SearchIndexServiceImpl

public interface SearchIndexService

The search index service.

Method Summary

Modifier and Type	Method and Description
SearchIndex	createSearchIndex(SearchIndexCreateRequest request) Creates a new search index.
SearchIndex	deleteSearchIndex(SearchIndexKey searchIndexKey) Deletes an existing search index for the specified key.
SearchIndex	getSearchIndex(SearchIndexKey searchIndexKey) Gets an existing search index for the specified key.
SearchIndexKeys	getSearchIndexes() Gets a list of search index keys for all search indexes defined in the system.

Method Detail

createSearchIndex

SearchIndex createSearchIndex(SearchIndexCreateRequest request)

Creates a new search index.

Parameters:

request - the information needed to create a search index

Returns:

the newly created search index

deleteSearchIndex

SearchIndex deleteSearchIndex(SearchIndexKey searchIndexKey)

Deletes an existing search index for the specified key.

Parameters:

searchIndexKey - the search index key

Returns:

the search index that was deleted

getSearchIndex

SearchIndex getSearchIndex(SearchIndexKey searchIndexKey)

Gets an existing search index for the specified key.

Parameters:

searchIndexKey - the search index key

Returns:

the retrieved search index

getSearchIndexes

SearchIndexKeys getSearchIndexes()

Gets a list of search index keys for all search indexes defined in the system.

Returns:

the search index keys