Interface ISearchService
-
public interface ISearchService
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description IExperimentImmutable
getExperimentByPermId(java.lang.String permId)
Get an experiment from the openBIS AS by its perm id.IMetaprojectAssignments
getMetaprojectAssignments(java.lang.String name)
IProjectImmutable
getProjectByPermId(java.lang.String permId)
Get a project from the openBIS AS by its perm id.ISampleImmutable
getSampleByPermId(java.lang.String permId)
Get a sample from the openBIS AS by its perm id.IVocabularyImmutable
getVocabulary(java.lang.String code)
java.util.List<IExperimentImmutable>
listExperiments(java.lang.String projectIdentifier)
List all experiments for a given project.java.util.List<IMaterialImmutable>
listMaterials(MaterialIdentifierCollection identifierCollection)
java.util.List<IMetaprojectImmutable>
listMetaprojects()
java.util.List<IMetaprojectImmutable>
listMetaprojectsForEntity(IMetaprojectContent entity)
java.util.List<IPropertyAssignmentImmutable>
listPropertiesDefinitionsForDataSetType(java.lang.String code)
java.util.List<IPropertyAssignmentImmutable>
listPropertiesDefinitionsForExperimentType(java.lang.String code)
java.util.List<IPropertyAssignmentImmutable>
listPropertiesDefinitionsForMaterialType(java.lang.String code)
java.util.List<IPropertyAssignmentImmutable>
listPropertiesDefinitionsForSampleType(java.lang.String code)
java.util.List<IDataSetImmutable>
searchForDataSets(ch.systemsx.cisd.openbis.generic.shared.api.v1.dto.SearchCriteria searchCriteria)
List all data sets that match the given searchCriteria.java.util.List<IDataSetImmutable>
searchForDataSets(java.lang.String property, java.lang.String value, java.lang.String typeOrNull)
List all data sets with a given value for a particular property, optionally restricted to a specific type.java.util.List<IDataSetImmutable>
searchForDataSets(java.lang.String property, java.lang.String value, java.lang.String typeOrNull, boolean escape)
List all data sets with a given value for a particular property, optionally restricted to a specific type.java.util.List<ISampleImmutable>
searchForSamples(ch.systemsx.cisd.openbis.generic.shared.api.v1.dto.SearchCriteria searchCriteria)
List all samples that match the given searchCriteria.java.util.List<ISampleImmutable>
searchForSamples(java.lang.String property, java.lang.String value, java.lang.String typeOrNull)
List all samples with a given value for a particular property, optionally restricted to a specific type.java.util.List<ISampleImmutable>
searchForSamples(java.lang.String property, java.lang.String value, java.lang.String typeOrNull, boolean escape)
List all samples with a given value for a particular property, optionally restricted to a specific type.IVocabularyImmutable
searchForVocabulary(java.lang.String code)
Deprecated.usegetVocabulary(String)
instead
-
-
-
Method Detail
-
listExperiments
java.util.List<IExperimentImmutable> listExperiments(java.lang.String projectIdentifier)
List all experiments for a given project.- Parameters:
projectIdentifier
- The project identifier as a string (e.g., /SPACE-CODE/PROJECT-CODE).- Returns:
- A list of experiments for the specified project.
-
searchForDataSets
java.util.List<IDataSetImmutable> searchForDataSets(java.lang.String property, java.lang.String value, java.lang.String typeOrNull)
List all data sets with a given value for a particular property, optionally restricted to a specific type.- Parameters:
property
- The property of interest.value
- The value the property should have. This may contain wildcards.- Returns:
- A list of matching data sets.
-
searchForDataSets
java.util.List<IDataSetImmutable> searchForDataSets(java.lang.String property, java.lang.String value, java.lang.String typeOrNull, boolean escape)
List all data sets with a given value for a particular property, optionally restricted to a specific type.- Parameters:
property
- The property of interest.value
- The value the property should have. This may contain wildcards if escape is set tofalse
.escape
- Iftrue
, escape the value to search for it verbatimly.- Returns:
- A list of matching data sets.
-
searchForSamples
java.util.List<ISampleImmutable> searchForSamples(java.lang.String property, java.lang.String value, java.lang.String typeOrNull)
List all samples with a given value for a particular property, optionally restricted to a specific type.- Parameters:
property
- The property of interest.value
- The value the property should have. This may contain wildcards.- Returns:
- A list of matching samples.
-
searchForSamples
java.util.List<ISampleImmutable> searchForSamples(java.lang.String property, java.lang.String value, java.lang.String typeOrNull, boolean escape)
List all samples with a given value for a particular property, optionally restricted to a specific type.- Parameters:
property
- The property of interest.value
- The value the property should have. This may contain wildcards if escape is set tofalse
.escape
- Iftrue
, escape the value to search for it verbatimly.- Returns:
- A list of matching samples.
-
searchForDataSets
java.util.List<IDataSetImmutable> searchForDataSets(ch.systemsx.cisd.openbis.generic.shared.api.v1.dto.SearchCriteria searchCriteria)
List all data sets that match the given searchCriteria.- Parameters:
searchCriteria
- The criteria to match against.- Returns:
- A list of matching data sets.
-
searchForSamples
java.util.List<ISampleImmutable> searchForSamples(ch.systemsx.cisd.openbis.generic.shared.api.v1.dto.SearchCriteria searchCriteria)
List all samples that match the given searchCriteria.- Parameters:
searchCriteria
- The criteria to match against.- Returns:
- A list of matching samples.
-
listMaterials
java.util.List<IMaterialImmutable> listMaterials(MaterialIdentifierCollection identifierCollection)
- Parameters:
identifierCollection
- a collection containing the identifiers of the matching materials. Identifiers that do not exist in the openBIS database are ignored.- Returns:
- a list of materials matching the specified collection.
-
searchForVocabulary
@Deprecated IVocabularyImmutable searchForVocabulary(java.lang.String code)
Deprecated.usegetVocabulary(String)
instead- Returns:
- a controlled vocabulary with the given code. Returns null if the vocabulary with given code is not found.
-
getVocabulary
IVocabularyImmutable getVocabulary(java.lang.String code)
- Returns:
- a controlled vocabulary with the given code. Returns null if the vocabulary with given code is not found.
-
listPropertiesDefinitionsForDataSetType
java.util.List<IPropertyAssignmentImmutable> listPropertiesDefinitionsForDataSetType(java.lang.String code)
- Returns:
- the list of property definitions for a data set type.
-
listPropertiesDefinitionsForSampleType
java.util.List<IPropertyAssignmentImmutable> listPropertiesDefinitionsForSampleType(java.lang.String code)
- Returns:
- the list of property definitions for a sample type.
-
listPropertiesDefinitionsForExperimentType
java.util.List<IPropertyAssignmentImmutable> listPropertiesDefinitionsForExperimentType(java.lang.String code)
- Returns:
- the list of property definitions for an experiment type.
-
listPropertiesDefinitionsForMaterialType
java.util.List<IPropertyAssignmentImmutable> listPropertiesDefinitionsForMaterialType(java.lang.String code)
- Returns:
- the list of property definitions for a material type.
-
listMetaprojects
java.util.List<IMetaprojectImmutable> listMetaprojects()
- Returns:
- the list of metaprojects for the current user.
-
getMetaprojectAssignments
IMetaprojectAssignments getMetaprojectAssignments(java.lang.String name)
- Returns:
- the assignments for the given metaproject for current user.
-
listMetaprojectsForEntity
java.util.List<IMetaprojectImmutable> listMetaprojectsForEntity(IMetaprojectContent entity)
- Returns:
- metaprojects for current user, which are assigned to the given entity
-
getSampleByPermId
ISampleImmutable getSampleByPermId(java.lang.String permId)
Get a sample from the openBIS AS by its perm id. Returns null if the sample does not exist.- Returns:
- A sample or null
-
getProjectByPermId
IProjectImmutable getProjectByPermId(java.lang.String permId)
Get a project from the openBIS AS by its perm id.
-
getExperimentByPermId
IExperimentImmutable getExperimentByPermId(java.lang.String permId)
Get an experiment from the openBIS AS by its perm id.
-
-