org.finra.herd.service.functional

Interface SearchFunctions

All Known Implementing Classes:

ElasticsearchFunctions

public interface SearchFunctions

SearchFunctions interface used to provide search index functionality

Method Summary

Modifier and Type	Method and Description
TriConsumer<String,String,Map<String,String>>	getCreateIndexDocumentsFunction() The create index documents function will take as arguments the index name, document type, and a map of new documents.
TriConsumer<String,String,String>	getCreateIndexFunction() The create index function will take as arguments the index name, document type, and mapping and will create a new index.
TriConsumer<String,String,String>	getDeleteDocumentByIdFunction() The delete document by id function will delete a document in the index by the document id.
TriConsumer<String,String,List<Integer>>	getDeleteIndexDocumentsFunction() The delete index documents function will delete a list of document in the index by a list of document ids.
Consumer<String>	getDeleteIndexFunction() The delete index function will take as an argument the index name and will delete the index.
TriFunction<String,String,Set<String>,ElasticsearchResponseDto>	getFindAllBusinessObjectDefinitionsFunction() The find all business object definitions function will return all business object definition entities in the search index.
BiFunction<String,String,List<String>>	getIdsInIndexFunction() The ids in index function will take as arguments the index name and the document type and will return a list of all the ids in the index.
Predicate<String>	getIndexExistsFunction() The index exists predicate will take as an argument the index name and will return tree if the index exists and false otherwise.
QuadConsumer<String,String,String,String>	getIndexFunction() The index function will take as arguments indexName, documentType, id, json and add the document to the index.
QuadPredicate<String,String,String,String>	getIsValidFunction() The isValid function will take as arguments indexName, documentType, id, json and validate the document against the index and return true if the document is valid and false otherwise.
BiFunction<String,String,Long>	getNumberOfTypesInIndexFunction() The number of types in index function will take as arguments the index name and the document type and will return the number of documents in the index.
QuadFunction<String,String,List<List<TagEntity>>,Set<String>,ElasticsearchResponseDto>	getSearchBusinessObjectDefinitionsByTagsFunction() The search business object definitions by tags function will take a list of tag entities list and return a list of business object definition entities.
TriConsumer<String,String,Map<String,String>>	getUpdateIndexDocumentsFunction() The update index documents function will take as arguments the index name, document type, and a map of documents to update.
QuadConsumer<String,String,String,String>	getValidateFunction() The validate function will take as arguments indexName, documentType, id, json and validate the document against the index.

Method Detail

getIndexFunction

QuadConsumer<String,String,String,String> getIndexFunction()

The index function will take as arguments indexName, documentType, id, json and add the document to the index.

getValidateFunction

QuadConsumer<String,String,String,String> getValidateFunction()

The validate function will take as arguments indexName, documentType, id, json and validate the document against the index.

getIsValidFunction

QuadPredicate<String,String,String,String> getIsValidFunction()

The isValid function will take as arguments indexName, documentType, id, json and validate the document against the index and return true if the document is valid and false otherwise.

getIndexExistsFunction

Predicate<String> getIndexExistsFunction()

The index exists predicate will take as an argument the index name and will return tree if the index exists and false otherwise.

getDeleteIndexFunction

Consumer<String> getDeleteIndexFunction()

The delete index function will take as an argument the index name and will delete the index.

getCreateIndexDocumentsFunction

TriConsumer<String,String,Map<String,String>> getCreateIndexDocumentsFunction()

The create index documents function will take as arguments the index name, document type, and a map of new documents. The document map key is the document id, and the value is the document as a JSON string.

getCreateIndexFunction

TriConsumer<String,String,String> getCreateIndexFunction()

The create index function will take as arguments the index name, document type, and mapping and will create a new index.

getDeleteDocumentByIdFunction

TriConsumer<String,String,String> getDeleteDocumentByIdFunction()

The delete document by id function will delete a document in the index by the document id.

getDeleteIndexDocumentsFunction

TriConsumer<String,String,List<Integer>> getDeleteIndexDocumentsFunction()

The delete index documents function will delete a list of document in the index by a list of document ids.

getNumberOfTypesInIndexFunction

BiFunction<String,String,Long> getNumberOfTypesInIndexFunction()

The number of types in index function will take as arguments the index name and the document type and will return the number of documents in the index.

getIdsInIndexFunction

BiFunction<String,String,List<String>> getIdsInIndexFunction()

The ids in index function will take as arguments the index name and the document type and will return a list of all the ids in the index.

getFindAllBusinessObjectDefinitionsFunction

TriFunction<String,String,Set<String>,ElasticsearchResponseDto> getFindAllBusinessObjectDefinitionsFunction()

The find all business object definitions function will return all business object definition entities in the search index.

getSearchBusinessObjectDefinitionsByTagsFunction

QuadFunction<String,String,List<List<TagEntity>>,Set<String>,ElasticsearchResponseDto> getSearchBusinessObjectDefinitionsByTagsFunction()

The search business object definitions by tags function will take a list of tag entities list and return a list of business object definition entities. The function will search the search index based on tag code and tag type code.

getUpdateIndexDocumentsFunction

TriConsumer<String,String,Map<String,String>> getUpdateIndexDocumentsFunction()

The update index documents function will take as arguments the index name, document type, and a map of documents to update. The document map key is the document id, and the value is the document as a JSON string.