Interface ISearchService
public interface ISearchService
-
Method Summary
Modifier and TypeMethodDescriptiongetDataSet(String dataSetCode) Get a data set from the openBIS AS.getExperiment(String experimentIdentifierString) Deprecated.getExperimentByIdentifier(String experimentIdentifierString) Get an experiment from the openBIS AS.getExperimentByPermId(String permId) Get an experiment from the openBIS AS by its perm id.getMaterial(String identifier) Get a material from the openBIS AS.getMaterial(String materialCode, String materialType) Get a material from the openBIS AS.getMetaproject(String name) Get the given metaproject for the current usergetProject(String projectIdentifier) Deprecated.UsegetProjectByIdentifiergetProjectByIdentifier(String projectIdentifier) Get a project from the openBIS AS.getProjectByPermId(String permId) Get a project from the openBIS AS by its perm id.Deprecated.UsegetSampleByIdentifiergetSampleByIdentifier(String sampleIdentifierString) Get a sample from the openBIS AS.getSampleByPermId(String permId) Get a sample from the openBIS AS by its perm id.Get a space from the openBIS AS.getThinDataSet(String dataSetCode) Get a data set from the openBIS AS.getVocabulary(String code) listAllMaterials(String materialTypeCode) Return all materials of a given type.listExperiments(String projectIdentifier) List all experiments for a given project.listMaterials(MaterialIdentifierCollection identifierCollection) listMetaprojectsForEntities(Collection<? extends IMetaprojectContent> entity) searchForDataSets(ch.systemsx.cisd.openbis.generic.shared.api.v1.dto.SearchCriteria searchCriteria) List all data sets that match the given searchCriteria.searchForDataSets(String property, String value, String typeOrNull) List all data sets with a given value for a particular property, optionally restricted to a specific type.searchForDataSets(String property, String value, String typeOrNull, boolean escape) List all data sets with a given value for a particular property, optionally restricted to a specific type.searchForExperiments(ch.systemsx.cisd.openbis.generic.shared.api.v1.dto.SearchCriteria searchCriteria) List all experiments that match the given searchCriteria.searchForSamples(ch.systemsx.cisd.openbis.generic.shared.api.v1.dto.SearchCriteria searchCriteria) List all samples that match the given searchCriteria.searchForSamples(String property, String value, String typeOrNull) List all samples with a given value for a particular property, optionally restricted to a specific type.searchForSamples(String property, String value, String typeOrNull, boolean escape) List all samples with a given value for a particular property, optionally restricted to a specific type.searchForVocabulary(String code) Deprecated.usegetVocabulary(String)instead
-
Method Details
-
listExperiments
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
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
List<IDataSetImmutable> searchForDataSets(String property, String value, 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
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
List<ISampleImmutable> searchForSamples(String property, String value, 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.
-
searchForVocabulary
Deprecated.usegetVocabulary(String)instead- Returns:
- a controlled vocabulary with the given code. Returns null if the vocabulary with given code is not found.
-
getVocabulary
- Returns:
- a controlled vocabulary with the given code. Returns null if the vocabulary with given code is not found.
-
listPropertiesDefinitionsForDataSetType
- Returns:
- the list of property definitions for a data set type.
-
listPropertiesDefinitionsForSampleType
- Returns:
- the list of property definitions for a sample type.
-
listPropertiesDefinitionsForExperimentType
- Returns:
- the list of property definitions for an experiment type.
-
listPropertiesDefinitionsForMaterialType
- Returns:
- the list of property definitions for a material type.
-
listMetaprojects
List<IMetaprojectImmutable> listMetaprojects()- Returns:
- the list of metaprojects for the current user.
-
getMetaproject
Get the given metaproject for the current user -
getMetaprojectAssignments
- Returns:
- the assignments for the given metaproject for current user.
-
listMetaprojectsForEntities
Map<IMetaprojectContent,List<IMetaprojectImmutable>> listMetaprojectsForEntities(Collection<? extends IMetaprojectContent> entity) - Returns:
- metaprojects for current user, which are assigned to the given entities
-
getDataSet
Get a data set from the openBIS AS. Returns null if the data set does not exist.- Returns:
- A data set or null
-
getThinDataSet
Get a data set from the openBIS AS. Returns null if the data set does not exist. The returned data set will contain only basic information, and no related entities.- Returns:
- A data set or null
-
getSample
Deprecated.UsegetSampleByIdentifierGet a sample from the openBIS AS. Returns null if the sample does not exist.- Returns:
- A sample or null
-
getSampleByIdentifier
Get a sample from the openBIS AS. Returns null if the sample does not exist.- Returns:
- A sample or null
-
getExperiment
Deprecated.UsegetExperimentByIdentifierGet an experiment from the openBIS AS. -
getExperimentByIdentifier
Get an experiment from the openBIS AS. -
getProject
Deprecated.UsegetProjectByIdentifierGet a project from the openBIS AS. Returns null if the project does not exist.- Returns:
- A project or null
-
getProjectByIdentifier
Get a project from the openBIS AS. Returns null if the project does not exist.- Returns:
- A project or null
-
getSpace
Get a space from the openBIS AS. Returns null if the space does not exist.- Returns:
- A space or null
-
getMaterial
Get a material from the openBIS AS. Returns null if the material does not exist.- Returns:
- A material or null
-
getMaterial
Get a material from the openBIS AS. Returns null if the material does not exist.- Returns:
- A material or null
-
listAllMaterials
Return all materials of a given type. -
getSampleByPermId
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
Get a project from the openBIS AS by its perm id. -
getExperimentByPermId
Get an experiment from the openBIS AS by its perm id.
-
getExperimentByIdentifier