Interface ISearchDomainService


public interface ISearchDomainService
Interface for a search domain service. Implementing classes should have a public constructor with two arguments: First is an instance of Properties and second is an instance of File which points to the root of the data set store.
  • Method Summary

    Modifier and Type
    Method
    Description
    Returns the label of this search domain service instance.
    List<ch.systemsx.cisd.openbis.generic.shared.api.v1.dto.SearchDomainSearchOption>
    Returns all possible search options.
    Returns the key used in optionalParametersOrNull if this service supports different SearchDomainSearchOptions.
    boolean
    Returns true if this service is available.
    List<ch.systemsx.cisd.openbis.generic.shared.api.v1.dto.SearchDomainSearchResult>
    search(String searchString, Map<String,String> optionalParametersOrNull)
    Searches this service for the specified search string.
  • Method Details

    • getLabel

      String getLabel()
      Returns the label of this search domain service instance. It can be used for human readable output. Will be used to populated SearchDomain instances of the search result..
    • getPossibleSearchOptionsKey

      String getPossibleSearchOptionsKey()
      Returns the key used in optionalParametersOrNull if this service supports different SearchDomainSearchOptions.
      Returns:
      null if no such options supported.
    • getPossibleSearchOptions

      List<ch.systemsx.cisd.openbis.generic.shared.api.v1.dto.SearchDomainSearchOption> getPossibleSearchOptions()
      Returns all possible search options. The first option is the default option.
      Returns:
      an empty list if getPossibleSearchOptionsKey() return null.
    • isAvailable

      boolean isAvailable()
      Returns true if this service is available. For example, a local BLAST sequence search service is available if the external BLAST tools are available.
    • search

      List<ch.systemsx.cisd.openbis.generic.shared.api.v1.dto.SearchDomainSearchResult> search(String searchString, Map<String,String> optionalParametersOrNull)
      Searches this service for the specified search string.
      Parameters:
      optionalParametersOrNull - Optional parameters which might be used. Can be null.
      Returns:
      an empty list if nothing be found.