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 TypeMethodDescriptiongetLabel()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 inoptionalParametersOrNullif this service supports differentSearchDomainSearchOptions.booleanReturnstrueif this service is available.List<ch.systemsx.cisd.openbis.generic.shared.api.v1.dto.SearchDomainSearchResult>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 populatedSearchDomaininstances of the search result.. -
getPossibleSearchOptionsKey
String getPossibleSearchOptionsKey()Returns the key used inoptionalParametersOrNullif this service supports differentSearchDomainSearchOptions.- Returns:
nullif 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()returnnull.
-
isAvailable
boolean isAvailable()Returnstrueif 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 benull.- Returns:
- an empty list if nothing be found.
-