Package org.gbif.api.service.common

Interface SuggestService<T,P extends Enum<?> & SearchParameter,R extends SearchRequest<P>>

Type Parameters:
T - the type of returned results
P - the supported search parameter enumeration
R - the supported search request type. For faceted searches this needs to extend FacetedSearchRequest
All Known Subinterfaces:
DatasetSearchService, NameUsageSearchService
public interface SuggestService<T,P extends Enum<?> & SearchParameter,R extends SearchRequest<P>>
Generic search interface for a suggest/autocomplete service. This marker interface should be extended by other interfaces that support this functionality.

  • Method Summary

    Modifier and Type
    Method
    Description
    List<T>
    suggest(R suggestRequest)
    Issues a SearchRequest for a suggest and retrieves the list of matches.

  • Method Details

    • suggest

      List<T> suggest(R suggestRequest)
      Issues a SearchRequest for a suggest and retrieves the list of matches. The actual result information will contain a list elements of type T.
      Parameters:
      suggestRequest - the input object to be used for performing the operation.