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 ofProperties
and second is an instance ofFile
which points to the root of the data set store.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.String
getLabel()
Returns the label of this search domain service instance.java.util.List<ch.systemsx.cisd.openbis.generic.shared.api.v1.dto.SearchDomainSearchOption>
getPossibleSearchOptions()
Returns all possible search options.java.lang.String
getPossibleSearchOptionsKey()
Returns the key used inoptionalParametersOrNull
if this service supports differentSearchDomainSearchOption
s.boolean
isAvailable()
Returnstrue
if this service is available.java.util.List<ch.systemsx.cisd.openbis.generic.shared.api.v1.dto.SearchDomainSearchResult>
search(java.lang.String searchString, java.util.Map<java.lang.String,java.lang.String> optionalParametersOrNull)
Searches this service for the specified search string.
-
-
-
Method Detail
-
getLabel
java.lang.String getLabel()
Returns the label of this search domain service instance. It can be used for human readable output. Will be used to populatedSearchDomain
instances of the search result..
-
getPossibleSearchOptionsKey
java.lang.String getPossibleSearchOptionsKey()
Returns the key used inoptionalParametersOrNull
if this service supports differentSearchDomainSearchOption
s.- Returns:
null
if no such options supported.
-
getPossibleSearchOptions
java.util.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()
Returnstrue
if this service is available. For example, a local BLAST sequence search service is available if the external BLAST tools are available.
-
search
java.util.List<ch.systemsx.cisd.openbis.generic.shared.api.v1.dto.SearchDomainSearchResult> search(java.lang.String searchString, java.util.Map<java.lang.String,java.lang.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.
-
-