Package ch.systemsx.cisd.openbis.dss.client.api.v1

Interface IOpenbisServiceFacade

All Superinterfaces:

ISimpleOpenbisServiceFacade

All Known Implementing Classes:

OpenbisServiceFacade

public interface IOpenbisServiceFacade
extends ISimpleOpenbisServiceFacade

Provides a fully-blown API for openBIS integration. The internals of the openBIS architecture are abstracted away from the API users (e.g. they do not need to know openBIS is actually two servers - AS and DSS).

For the most basic operations (simple listing operations, data set upload/download) you can use instances of IOpenbisServiceFacade as "simple" ISimpleOpenbisServiceFacade.

Method Summary

Modifier and Type	Method	Description
void	addAdHocVocabularyTerm(TechId vocabularyId, java.lang.String code, java.lang.String label, java.lang.String description, java.lang.Long previousTermOrdinal)	Deprecated. Please use the addAdHocVocabularyTerm(Long, NewVocabularyTerm) method instead.
void	addAdHocVocabularyTerm(java.lang.Long vocabularyId, NewVocabularyTerm term)	Adds new ad-hoc terms to a vocabulary starting from specified ordinal + 1.
java.util.HashMap<Vocabulary,java.util.List<ControlledVocabularyPropertyType.VocabularyTerm>>	getVocabularyTermsMap()	Deprecated. Please use the ISimpleOpenbisServiceFacade.listVocabularies() method instead.
WebAppSettings	getWebAppSettings(java.lang.String webAppId)	Returns the persistent settings for a given custom web app.
java.util.List<DataSet>	listDataSets(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>	searchForDataSets(SearchCriteria searchCriteria)	Return all data sets matching a specified search criteria.
java.util.List<Experiment>	searchForExperiments(SearchCriteria searchCriteria)	Returns all experiments matching specified search criteria.
java.util.List<Sample>	searchForSamples(SearchCriteria searchCriteria)	Return all samples that match the search criteria.
java.util.List<Sample>	searchForSamples(SearchCriteria searchCriteria, java.util.EnumSet<SampleFetchOption> fetchOptions)	Return all samples that match the search criteria.
void	setWebAppSettings(WebAppSettings customDisplaySettings)	Sets the persistent settings for a given custom web app.

Methods inherited from interface ch.systemsx.cisd.openbis.dss.client.api.v1.ISimpleOpenbisServiceFacade

checkSession, extractMetadata, getDataSet, getDataSets, getExperiments, getMinorVersionInformationService, getSamples, getSamples, getSpacesWithProjects, listDataSetsForExperiment, listDataSetsForExperiments, listDataSetsForSample, listDataSetsForSamples, listDataSetTypes, listExperimentsForProjects, listExperimentsHavingDataSetsForProjects, listExperimentsHavingSamplesForProjects, listExperimentTypes, listProjects, listSamplesForExperimentAndSampleType, listSamplesForExperiments, listSamplesForExperiments, listSamplesForProjects, listSamplesForProjects, listSamplesOfSample, listSampleTypes, listVocabularies, logout, putDataSet, validateDataSet

Method Detail

getWebAppSettings

WebAppSettings getWebAppSettings(java.lang.String webAppId)

Returns the persistent settings for a given custom web app.

Parameters:

webAppId - The id of the custom web app to get the display settings for.

setWebAppSettings

void setWebAppSettings(WebAppSettings customDisplaySettings)

Sets the persistent settings for a given custom web app.

Parameters:

customDisplaySettings - The new display settings

searchForExperiments

java.util.List<Experiment> searchForExperiments(SearchCriteria searchCriteria)

Returns all experiments matching specified search criteria.

searchForSamples

java.util.List<Sample> searchForSamples(SearchCriteria searchCriteria)

Return all samples that match the search criteria. This is a short cut for

 searchForSamples(searchCritera, EnumSet.of(SampleFetchOption.PROPERTIES))
 

Parameters:

searchCriteria - The sample metadata values to be matched against.

searchForSamples

java.util.List<Sample> searchForSamples(SearchCriteria searchCriteria,
                                        java.util.EnumSet<SampleFetchOption> fetchOptions)

Return all samples that match the search criteria.

Parameters:

searchCriteria - The sample metadata values to be matched against.

fetchOptions - Describes the amount of information about the sample that is needed. For more details see IGeneralInformationService.searchForSamples(String, SearchCriteria, EnumSet) .

searchForDataSets

java.util.List<DataSet> searchForDataSets(SearchCriteria searchCriteria)

Return all data sets matching a specified search criteria.

Parameters:

searchCriteria - the criteria used for searching.

listDataSets

java.util.List<DataSet> listDataSets(java.util.List<Sample> samples,
                                     java.util.EnumSet<DataSet.Connections> connectionsToGet)

Return all data sets attached to the given samples with connections.

Parameters:

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

addAdHocVocabularyTerm

@Deprecated
void addAdHocVocabularyTerm(TechId vocabularyId,
                            java.lang.String code,
                            java.lang.String label,
                            java.lang.String description,
                            java.lang.Long previousTermOrdinal)

Deprecated.

Please use the addAdHocVocabularyTerm(Long, NewVocabularyTerm) method instead.

Adds new ad-hoc terms to a vocabulary starting from specified ordinal + 1.

Parameters:

vocabularyId - The id of vocabulary which should be extended.

code - Code of new vocabulary term.

label - Label of new vocabulary term.

description - Free text describing new vocabulary term.

previousTermOrdinal - new vocabulary term will be placed right after vocabulary term with given ordinal number.

addAdHocVocabularyTerm

void addAdHocVocabularyTerm(java.lang.Long vocabularyId,
                            NewVocabularyTerm term)

Adds new ad-hoc terms to a vocabulary starting from specified ordinal + 1.

Parameters:

vocabularyId - The id of vocabulary which should be extended.

term - the vocabulary term to be added.

getVocabularyTermsMap

@Deprecated
java.util.HashMap<Vocabulary,java.util.List<ControlledVocabularyPropertyType.VocabularyTerm>> getVocabularyTermsMap()

Deprecated.

Please use the ISimpleOpenbisServiceFacade.listVocabularies() method instead.

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