public interface ISearchService
  • Method Details

    • listExperiments

      List<IExperimentImmutable> listExperiments(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

      List<IDataSetImmutable> 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.
      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 to false.
      escape - If true, escape the value to search for it verbatimly.
      Returns:
      A list of matching data sets.
    • searchForSamples

      List<ISampleImmutable> searchForSamples(String property, String value, 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

      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 to false.
      escape - If true, escape the value to search for it verbatimly.
      Returns:
      A list of matching samples.
    • searchForDataSets

      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

      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

      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(String code)
      Deprecated.
      Returns:
      a controlled vocabulary with the given code. Returns null if the vocabulary with given code is not found.
    • getVocabulary

      IVocabularyImmutable getVocabulary(String code)
      Returns:
      a controlled vocabulary with the given code. Returns null if the vocabulary with given code is not found.
    • listPropertiesDefinitionsForDataSetType

      List<IPropertyAssignmentImmutable> listPropertiesDefinitionsForDataSetType(String code)
      Returns:
      the list of property definitions for a data set type.
    • listPropertiesDefinitionsForSampleType

      List<IPropertyAssignmentImmutable> listPropertiesDefinitionsForSampleType(String code)
      Returns:
      the list of property definitions for a sample type.
    • listPropertiesDefinitionsForExperimentType

      List<IPropertyAssignmentImmutable> listPropertiesDefinitionsForExperimentType(String code)
      Returns:
      the list of property definitions for an experiment type.
    • listPropertiesDefinitionsForMaterialType

      List<IPropertyAssignmentImmutable> listPropertiesDefinitionsForMaterialType(String code)
      Returns:
      the list of property definitions for a material type.
    • listMetaprojects

      List<IMetaprojectImmutable> listMetaprojects()
      Returns:
      the list of metaprojects for the current user.
    • getMetaprojectAssignments

      IMetaprojectAssignments getMetaprojectAssignments(String name)
      Returns:
      the assignments for the given metaproject for current user.
    • listMetaprojectsForEntity

      List<IMetaprojectImmutable> listMetaprojectsForEntity(IMetaprojectContent entity)
      Returns:
      metaprojects for current user, which are assigned to the given entity
    • getSampleByPermId

      ISampleImmutable getSampleByPermId(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(String permId)
      Get a project from the openBIS AS by its perm id.
    • getExperimentByPermId

      IExperimentImmutable getExperimentByPermId(String permId)
      Get an experiment from the openBIS AS by its perm id.