Package ch.systemsx.cisd.openbis.dss.generic.shared.api.internal.v2

Interface ISearchService

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.

    • searchForExperiments

      List<IExperimentImmutable> searchForExperiments(ch.systemsx.cisd.openbis.generic.shared.api.v1.dto.SearchCriteria searchCriteria)
      List all experiments that match the given searchCriteria.
      Parameters:
      searchCriteria - The criteria to match against.
      Returns:
      A list of matching experiments.

    • searchForVocabulary

      @Deprecated IVocabularyImmutable searchForVocabulary(String code)
      Deprecated.
      use getVocabulary(String) instead
      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.

    • listMetaprojects

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

    • getMetaproject

      IMetaprojectImmutable getMetaproject(String name)
      Get the given metaproject 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

    • listMetaprojectsForEntities

      Map<IMetaprojectContent,List<IMetaprojectImmutable>> listMetaprojectsForEntities(Collection<? extends IMetaprojectContent> entity)
      Returns:
      metaprojects for current user, which are assigned to the given entities

    • getDataSet

      IDataSetImmutable getDataSet(String dataSetCode)
      Get a data set from the openBIS AS. Returns null if the data set does not exist.
      Returns:
      A data set or null

    • getThinDataSet

      IDataSetImmutable getThinDataSet(String dataSetCode)
      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 ISampleImmutable getSample(String sampleIdentifierString)
      Deprecated.
      Use getSampleByIdentifier
      Get a sample from the openBIS AS. Returns null if the sample does not exist.
      Returns:
      A sample or null

    • getSampleByIdentifier

      ISampleImmutable getSampleByIdentifier(String sampleIdentifierString)
      Get a sample from the openBIS AS. Returns null if the sample does not exist.
      Returns:
      A sample or null

    • getExperiment

      @Deprecated IExperimentImmutable getExperiment(String experimentIdentifierString)
      Deprecated.
      Use getExperimentByIdentifier
      Get an experiment from the openBIS AS.

    • getExperimentByIdentifier

      IExperimentImmutable getExperimentByIdentifier(String experimentIdentifierString)
      Get an experiment from the openBIS AS.

    • getProject

      @Deprecated IProjectImmutable getProject(String projectIdentifier)
      Deprecated.
      Use getProjectByIdentifier
      Get a project from the openBIS AS. Returns null if the project does not exist.
      Returns:
      A project or null

    • getProjectByIdentifier

      IProjectImmutable getProjectByIdentifier(String projectIdentifier)
      Get a project from the openBIS AS. Returns null if the project does not exist.
      Returns:
      A project or null

    • getSpace

      ISpaceImmutable getSpace(String spaceCode)
      Get a space from the openBIS AS. Returns null if the space does not exist.
      Returns:
      A space or null

    • 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.