|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IGeneralInformationService
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 |
---|
static final java.lang.String SERVICE_NAME
static final java.lang.String SERVICE_URL
static final java.lang.String JSON_SERVICE_URL
Method Detail |
---|
java.lang.String tryToAuthenticateForAllServices(java.lang.String userID, java.lang.String userPassword)
null
is returned. The returned session token can be used for
all methods and interfaces of the same openBIS server.
void logout(java.lang.String sessionToken)
boolean isSessionActive(java.lang.String sessionToken)
java.util.Map<java.lang.String,java.util.Set<Role>> listNamedRoleSets(java.lang.String sessionToken)
java.util.List<SpaceWithProjectsAndRoleAssignments> listSpacesWithProjectsAndRoleAssignments(java.lang.String sessionToken, java.lang.String databaseInstanceCodeOrNull)
databaseInstanceCodeOrNull
- Code of an imported database instance or null
for the home database instance is meant.java.util.List<Sample> searchForSamples(java.lang.String sessionToken, SearchCriteria searchCriteria)
searchForSamples(sessionToken, searchCritera, EnumSet.of(SampleFetchOption.PROPERTIES))
searchCriteria
- The sample metadata values to be matched against.java.util.List<Sample> searchForSamples(java.lang.String sessionToken, SearchCriteria searchCriteria, java.util.EnumSet<SampleFetchOption> fetchOptions)
The fetch options set is interpreted by the following rules.
SampleFetchOption.PROPERTIES
only the basic attributes are
returned for all samples including possible ancestors and descendants.
SampleFetchOption.CHILDREN
will be ignored if
SampleFetchOption.DESCENDANTS
is in the set.
SampleFetchOption.PARENTS
will be ignored if SampleFetchOption.ANCESTORS
is in the set.
SampleFetchOption.CHILDREN
/
SampleFetchOption.DESCENDANTS
with SampleFetchOption.PARENTS
/
SampleFetchOption.ANCESTORS
.
searchCriteria
- The sample metadata values to be matched against.fetchOptions
- Options that control which parts of the samples are fetched.java.util.List<Sample> listSamplesForExperiment(java.lang.String sessionToken, java.lang.String experimentIdentifierString)
experimentIdentifierString
- The identifier of the experiment samples will be listed
for.java.util.List<DataSet> listDataSets(java.lang.String sessionToken, java.util.List<Sample> samples)
samples
- The samples for which we return attached data sets.java.util.List<Experiment> listExperiments(java.lang.String sessionToken, java.util.List<Project> projects, java.lang.String experimentType)
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.java.util.List<Experiment> listExperimentsHavingSamples(java.lang.String sessionToken, java.util.List<Project> projects, java.lang.String experimentType)
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.java.util.List<Experiment> listExperimentsHavingDataSets(java.lang.String sessionToken, java.util.List<Project> projects, java.lang.String experimentType)
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.java.util.List<DataSet> listDataSetsForSample(java.lang.String sessionToken, Sample sample, boolean areOnlyDirectlyConnectedIncluded)
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.java.lang.String getDefaultPutDataStoreBaseURL(java.lang.String sessionToken)
java.lang.String tryGetDataStoreBaseURL(java.lang.String sessionToken, java.lang.String dataSetCode)
java.util.List<DataSetType> listDataSetTypes(java.lang.String sessionToken)
@Deprecated java.util.HashMap<ch.systemsx.cisd.openbis.generic.shared.basic.dto.Vocabulary,java.util.List<ControlledVocabularyPropertyType.VocabularyTerm>> getVocabularyTermsMap(java.lang.String sessionToken)
listVocabularies(String)
instead.
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.
java.util.List<Vocabulary> listVocabularies(java.lang.String sessionToken)
java.util.List<DataSet> listDataSets(java.lang.String sessionToken, java.util.List<Sample> samples, java.util.EnumSet<DataSet.Connections> connectionsToGet)
samples
- The samples for which we return attached data sets.java.util.List<DataSet> listDataSetsForExperiments(java.lang.String sessionToken, java.util.List<Experiment> experiments, java.util.EnumSet<DataSet.Connections> connectionsToGet)
experiments
- The experiments for which we return attached data sets.java.util.List<DataSet> getDataSetMetaData(java.lang.String sessionToken, java.util.List<java.lang.String> dataSetCodes)
DataSet.getContainedDataSets()
is always empty.
Available since minor version 12.
dataSetCodes
- Codes of requested data sets.
java.util.List<DataSet> getDataSetMetaData(java.lang.String sessionToken, java.util.List<java.lang.String> dataSetCodes, java.util.EnumSet<DataSetFetchOption> fetchOptions)
fetchOptions
parameter. Available since minor
version 16.
dataSetCodes
- Codes of requested data sets.fetchOptions
- Options that control which parts of the data sets are fetched.
java.util.List<DataSet> searchForDataSets(java.lang.String sessionToken, SearchCriteria searchCriteria)
searchCriteria
- the criteria used for searching.java.util.List<Experiment> listExperiments(java.lang.String sessionToken, java.util.List<java.lang.String> experimentIdentifiers)
experimentIdentifiers
- the identifiers of the experiments to be returned.java.util.List<Project> listProjects(java.lang.String sessionToken)
java.util.List<Material> getMaterialByCodes(java.lang.String sessionToken, java.util.List<MaterialIdentifier> materialIdentifier)
java.util.List<Material> searchForMaterials(java.lang.String sessionToken, SearchCriteria searchCriteria)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |