ch.systemsx.cisd.openbis.generic.shared.api.v1
Interface IGeneralInformationService

All Superinterfaces:
IRpcService

public interface IGeneralInformationService
extends IRpcService

Service for retrieving general informations.


Field Summary
static java.lang.String JSON_SERVICE_URL
           
static java.lang.String SERVICE_NAME
          Name of this service for which it is registered at the RPC name server.
static java.lang.String SERVICE_URL
          Application part of the URL to access this service remotely.
 
Method Summary
 java.util.List<DataSet> getDataSetMetaData(java.lang.String sessionToken, java.util.List<java.lang.String> dataSetCodes)
          Returns meta data for all specified data sets.
 java.util.List<DataSet> getDataSetMetaData(java.lang.String sessionToken, java.util.List<java.lang.String> dataSetCodes, java.util.EnumSet<DataSetFetchOption> fetchOptions)
          Returns meta data for all specified data sets.
 java.lang.String getDefaultPutDataStoreBaseURL(java.lang.String sessionToken)
          Returns the URL for the default data store server for this openBIS AS.
 java.util.List<Material> getMaterialByCodes(java.lang.String sessionToken, java.util.List<MaterialIdentifier> materialIdentifier)
          Returns the materials with specified identifiers (i.e.
 java.util.HashMap<ch.systemsx.cisd.openbis.generic.shared.basic.dto.Vocabulary,java.util.List<ControlledVocabularyPropertyType.VocabularyTerm>> getVocabularyTermsMap(java.lang.String sessionToken)
          Deprecated. Please use listVocabularies(String) instead.
 boolean isSessionActive(java.lang.String sessionToken)
          Returns true if session with the specified token is still active, false otherwise.
 java.util.List<DataSet> listDataSets(java.lang.String sessionToken, java.util.List<Sample> samples)
          Return all data sets attached to the given samples.
 java.util.List<DataSet> listDataSets(java.lang.String sessionToken, java.util.List<Sample> samples, java.util.EnumSet<DataSet.Connections> connectionsToGet)
          Return all data sets attached to the given samples with connections.
 java.util.List<DataSet> listDataSetsForExperiments(java.lang.String sessionToken, java.util.List<Experiment> experiments, java.util.EnumSet<DataSet.Connections> connectionsToGet)
          Return all data sets attached to the given experiments with connections.
 java.util.List<DataSet> listDataSetsForSample(java.lang.String sessionToken, Sample sample, boolean areOnlyDirectlyConnectedIncluded)
          Return the data sets attached to the specified sample, optionally including child samples.
 java.util.List<DataSetType> listDataSetTypes(java.lang.String sessionToken)
          Returns the URL for the default data store server for this openBIS AS.
 java.util.List<Experiment> listExperiments(java.lang.String sessionToken, java.util.List<Project> projects, java.lang.String experimentType)
          Return all experiments of the given type that belong to the supplied projects.
 java.util.List<Experiment> listExperiments(java.lang.String sessionToken, java.util.List<java.lang.String> experimentIdentifiers)
          Return all experiments matching a specified set of identifiers.
 java.util.List<Experiment> listExperimentsHavingDataSets(java.lang.String sessionToken, java.util.List<Project> projects, java.lang.String experimentType)
          Return all experiments of the given type that belong to the supplied projects and have registered data sets.
 java.util.List<Experiment> listExperimentsHavingSamples(java.lang.String sessionToken, java.util.List<Project> projects, java.lang.String experimentType)
          Return all experiments of the given type that belong to the supplied projects and have registered samles.
 java.util.Map<java.lang.String,java.util.Set<Role>> listNamedRoleSets(java.lang.String sessionToken)
          Returns all named role sets.
 java.util.List<Project> listProjects(java.lang.String sessionToken)
          Returns all available projects.
 java.util.List<Sample> listSamplesForExperiment(java.lang.String sessionToken, java.lang.String experimentIdentifierString)
          Return all samples that belong to the supplied experiment.
 java.util.List<SpaceWithProjectsAndRoleAssignments> listSpacesWithProjectsAndRoleAssignments(java.lang.String sessionToken, java.lang.String databaseInstanceCodeOrNull)
          Returns all spaces of specified database instance enriched with their projects and role assignments.
 java.util.List<Vocabulary> listVocabularies(java.lang.String sessionToken)
          Returns all available vocabularies together with the contained terms.
 void logout(java.lang.String sessionToken)
          Logout the session with the specified session token.
 java.util.List<DataSet> searchForDataSets(java.lang.String sessionToken, SearchCriteria searchCriteria)
          Return all data sets matching a specified search criteria.
 java.util.List<Material> searchForMaterials(java.lang.String sessionToken, SearchCriteria searchCriteria)
          Returns all material fulfilling specified search criteria.
 java.util.List<Sample> searchForSamples(java.lang.String sessionToken, SearchCriteria searchCriteria)
          Return all samples that match the search criteria.
 java.util.List<Sample> searchForSamples(java.lang.String sessionToken, SearchCriteria searchCriteria, java.util.EnumSet<SampleFetchOption> fetchOptions)
          Return all samples that match the search criteria.
 java.lang.String tryGetDataStoreBaseURL(java.lang.String sessionToken, java.lang.String dataSetCode)
          Returns the download URL for the data store of specified data set or null if such data set does not exist.
 java.lang.String tryToAuthenticateForAllServices(java.lang.String userID, java.lang.String userPassword)
          Tries to authenticate specified user with specified password.
 
Methods inherited from interface ch.systemsx.cisd.common.api.IRpcService
getMajorVersion, getMinorVersion
 

Field Detail

SERVICE_NAME

static final java.lang.String SERVICE_NAME
Name of this service for which it is registered at the RPC name server.

See Also:
Constant Field Values

SERVICE_URL

static final java.lang.String SERVICE_URL
Application part of the URL to access this service remotely.

See Also:
Constant Field Values

JSON_SERVICE_URL

static final java.lang.String JSON_SERVICE_URL
See Also:
Constant Field Values
Method Detail

tryToAuthenticateForAllServices

java.lang.String tryToAuthenticateForAllServices(java.lang.String userID,
                                                 java.lang.String userPassword)
Tries to authenticate specified user with specified password. Returns session token if succeeded otherwise null is returned. The returned session token can be used for all methods and interfaces of the same openBIS server.


logout

void logout(java.lang.String sessionToken)
Logout the session with the specified session token.


isSessionActive

boolean isSessionActive(java.lang.String sessionToken)
Returns true if session with the specified token is still active, false otherwise. Available since minor version 4.

Since:
1.4

listNamedRoleSets

java.util.Map<java.lang.String,java.util.Set<Role>> listNamedRoleSets(java.lang.String sessionToken)
Returns all named role sets. The name is the key of the returned map.


listSpacesWithProjectsAndRoleAssignments

java.util.List<SpaceWithProjectsAndRoleAssignments> listSpacesWithProjectsAndRoleAssignments(java.lang.String sessionToken,
                                                                                             java.lang.String databaseInstanceCodeOrNull)
Returns all spaces of specified database instance enriched with their projects and role assignments.

Parameters:
databaseInstanceCodeOrNull - Code of an imported database instance or null for the home database instance is meant.

searchForSamples

java.util.List<Sample> searchForSamples(java.lang.String sessionToken,
                                        SearchCriteria searchCriteria)
Return all samples that match the search criteria. Available since minor version 1. This is a short cut for
 searchForSamples(sessionToken, searchCritera, EnumSet.of(SampleFetchOption.PROPERTIES))
 

Parameters:
searchCriteria - The sample metadata values to be matched against.
Since:
1.1

searchForSamples

java.util.List<Sample> searchForSamples(java.lang.String sessionToken,
                                        SearchCriteria searchCriteria,
                                        java.util.EnumSet<SampleFetchOption> fetchOptions)
Return all samples that match the search criteria. Available since minor version 17.

The fetch options set is interpreted by the following rules.

The samples of the returned list also contain appropriated fetch options sets which tells whether one can expect properties, children, or parents. Note, that only the top-level samples can have both children or samples. For descendants and ancestors navigation is possible only in one direction.

Parameters:
searchCriteria - The sample metadata values to be matched against.
fetchOptions - Options that control which parts of the samples are fetched.
Since:
1.17

listSamplesForExperiment

java.util.List<Sample> listSamplesForExperiment(java.lang.String sessionToken,
                                                java.lang.String experimentIdentifierString)
Return all samples that belong to the supplied experiment. Available since minor version 1.

Parameters:
experimentIdentifierString - The identifier of the experiment samples will be listed for.
Since:
1.1

listDataSets

java.util.List<DataSet> listDataSets(java.lang.String sessionToken,
                                     java.util.List<Sample> samples)
Return all data sets attached to the given samples. Available since minor version 1.

Parameters:
samples - The samples for which we return attached data sets.

listExperiments

java.util.List<Experiment> listExperiments(java.lang.String sessionToken,
                                           java.util.List<Project> projects,
                                           java.lang.String experimentType)
Return all experiments of the given type that belong to the supplied projects. Available since minor version 2.

Parameters:
projects - The projects for which we return attached experiments.
experimentType - The experiment type of the experiments we want to list. Since version 1.9 NULL are accepted. Specifying a NULL experiment type will result in all experiments for the specified projects being returned.
Since:
1.2

listExperimentsHavingSamples

java.util.List<Experiment> listExperimentsHavingSamples(java.lang.String sessionToken,
                                                        java.util.List<Project> projects,
                                                        java.lang.String experimentType)
Return all experiments of the given type that belong to the supplied projects and have registered samles. Available since minor version 15.

Parameters:
projects - The projects for which we return attached experiments.
experimentType - The experiment type of the experiments we want to list. Specifying a NULL experiment type will result in all experiments for the specified projects being returned.
Since:
1.15

listExperimentsHavingDataSets

java.util.List<Experiment> listExperimentsHavingDataSets(java.lang.String sessionToken,
                                                         java.util.List<Project> projects,
                                                         java.lang.String experimentType)
Return all experiments of the given type that belong to the supplied projects and have registered data sets. Available since minor version 15.

Parameters:
projects - The projects for which we return attached experiments.
experimentType - The experiment type of the experiments we want to list. Specifying a NULL experiment type will result in all experiments for the specified projects being returned.
Since:
1.15

listDataSetsForSample

java.util.List<DataSet> listDataSetsForSample(java.lang.String sessionToken,
                                              Sample sample,
                                              boolean areOnlyDirectlyConnectedIncluded)
Return the data sets attached to the specified sample, optionally including child samples. Note, that for returned container data sets the contained data sets have only code, type and registration date set. Available since minor version 3.

Parameters:
sample - The sample for which we return attached data sets.
areOnlyDirectlyConnectedIncluded - If true, only data sets that are directly connected to the sample are included, otherwise data sets of child samples are included as well.
Since:
1.3

getDefaultPutDataStoreBaseURL

java.lang.String getDefaultPutDataStoreBaseURL(java.lang.String sessionToken)
Returns the URL for the default data store server for this openBIS AS. Available since minor version 4.

Since:
1.4

tryGetDataStoreBaseURL

java.lang.String tryGetDataStoreBaseURL(java.lang.String sessionToken,
                                        java.lang.String dataSetCode)
Returns the download URL for the data store of specified data set or null if such data set does not exist. Available since minor version 4.

Since:
1.4

listDataSetTypes

java.util.List<DataSetType> listDataSetTypes(java.lang.String sessionToken)
Returns the URL for the default data store server for this openBIS AS. Available since minor version 5.

Since:
1.5

getVocabularyTermsMap

@Deprecated
java.util.HashMap<ch.systemsx.cisd.openbis.generic.shared.basic.dto.Vocabulary,java.util.List<ControlledVocabularyPropertyType.VocabularyTerm>> getVocabularyTermsMap(java.lang.String sessionToken)
Deprecated. Please use listVocabularies(String) instead.

Returns map of avaialable vocabulary terms. Available since minor version 6.

The method cannot be fully utilized over JSON-RPC, because there is no sensible way to (de)serialize a Vocabulary object to/from String. Any working implementation will make the life of non-java clients (e.g. Javascript) unnecessarily complicated.

Since:
1.6

listVocabularies

java.util.List<Vocabulary> listVocabularies(java.lang.String sessionToken)
Returns all available vocabularies together with the contained terms.

Since:
1.13

listDataSets

java.util.List<DataSet> listDataSets(java.lang.String sessionToken,
                                     java.util.List<Sample> samples,
                                     java.util.EnumSet<DataSet.Connections> connectionsToGet)
Return all data sets attached to the given samples with connections. Available since minor version 7.

Parameters:
samples - The samples for which we return attached data sets.
Since:
1.7

listDataSetsForExperiments

java.util.List<DataSet> listDataSetsForExperiments(java.lang.String sessionToken,
                                                   java.util.List<Experiment> experiments,
                                                   java.util.EnumSet<DataSet.Connections> connectionsToGet)
Return all data sets attached to the given experiments with connections. Available since minor version 14.

Parameters:
experiments - The experiments for which we return attached data sets.
Since:
1.14

getDataSetMetaData

java.util.List<DataSet> getDataSetMetaData(java.lang.String sessionToken,
                                           java.util.List<java.lang.String> dataSetCodes)
Returns meta data for all specified data sets. This contains data set type, properties, and codes of linked parent and children data sets. For container data sets the contained data sets are not returned. Thus, DataSet.getContainedDataSets() is always empty. Available since minor version 12.

Parameters:
dataSetCodes - Codes of requested data sets.
Returns:
result in the same order as the list of data set codes.
Since:
1.12

getDataSetMetaData

java.util.List<DataSet> getDataSetMetaData(java.lang.String sessionToken,
                                           java.util.List<java.lang.String> dataSetCodes,
                                           java.util.EnumSet<DataSetFetchOption> fetchOptions)
Returns meta data for all specified data sets. Which parts of the data sets objects are fetched is controlled with the fetchOptions parameter. Available since minor version 16.

Parameters:
dataSetCodes - Codes of requested data sets.
fetchOptions - Options that control which parts of the data sets are fetched.
Returns:
result in the same order as the list of data set codes.
Since:
1.16

searchForDataSets

java.util.List<DataSet> searchForDataSets(java.lang.String sessionToken,
                                          SearchCriteria searchCriteria)
Return all data sets matching a specified search criteria. Note, that for returned container data sets the contained data sets have only code, type and registration date set. Available since minor version 8.

Parameters:
searchCriteria - the criteria used for searching.
Since:
1.8

listExperiments

java.util.List<Experiment> listExperiments(java.lang.String sessionToken,
                                           java.util.List<java.lang.String> experimentIdentifiers)
Return all experiments matching a specified set of identifiers. Available since minor version 9.

Parameters:
experimentIdentifiers - the identifiers of the experiments to be returned.
Since:
1.9

listProjects

java.util.List<Project> listProjects(java.lang.String sessionToken)
Returns all available projects.


getMaterialByCodes

java.util.List<Material> getMaterialByCodes(java.lang.String sessionToken,
                                            java.util.List<MaterialIdentifier> materialIdentifier)
Returns the materials with specified identifiers (i.e. code and type).


searchForMaterials

java.util.List<Material> searchForMaterials(java.lang.String sessionToken,
                                            SearchCriteria searchCriteria)
Returns all material fulfilling specified search criteria.