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

Interface ISearchService

  • public interface ISearchService

    • 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 to false.
        escape - If true, 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 to false.
        escape - If true, 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.

      • searchForExperiments

        java.util.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.

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

      • getMetaproject

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

      • getDataSet

        IDataSetImmutable getDataSet​(java.lang.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​(java.lang.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​(java.lang.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​(java.lang.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​(java.lang.String experimentIdentifierString)
        Deprecated.
        Use getExperimentByIdentifier
        Get an experiment from the openBIS AS.

      • getExperimentByIdentifier

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

      • getProject

        @Deprecated
IProjectImmutable getProject​(java.lang.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​(java.lang.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​(java.lang.String spaceCode)
        Get a space from the openBIS AS. Returns null if the space does not exist.
        Returns:
        A space or null

      • getMaterial

        IMaterialImmutable getMaterial​(java.lang.String materialCode,
                               java.lang.String materialType)
        Get a material from the openBIS AS. Returns null if the material does not exist.
        Returns:
        A material or null

      • getMaterial

        IMaterialImmutable getMaterial​(java.lang.String identifier)
        Get a material from the openBIS AS. Returns null if the material does not exist.
        Returns:
        A material or null

      • listAllMaterials

        java.util.List<IMaterialImmutable> listAllMaterials​(java.lang.String materialTypeCode)
        Return all materials of a given type.

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