org.finra.herd.service

Interface IndexSearchService

All Known Implementing Classes:

IndexSearchServiceImpl

public interface IndexSearchService

IndexSearchService

Method Summary

Modifier and Type	Method and Description
IndexSearchResponse	indexSearch(IndexSearchRequest request, Set<String> fields, Set<String> match) The index indexSearch method will take as parameters an index indexSearch request that contains a indexSearch term string, and a set of field strings.

Method Detail

indexSearch

IndexSearchResponse indexSearch(IndexSearchRequest request,
                                Set<String> fields,
                                Set<String> match)

The index indexSearch method will take as parameters an index indexSearch request that contains a indexSearch term string, and a set of field strings. It will perform an index indexSearch on the indexSearch term and return the fields specified in the index indexSearch response. The search may be constrained by a set of match fields that will limit the search to the fields specified.

Parameters:

request - the index indexSearch request that contains a indexSearch term string

fields - the set of fields that are to be returned in the index indexSearch response

match - the set of match fields that are to be searched upon in the index search

Returns:

an index indexSearch response object containing the total index indexSearch results and index indexSearch results