|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IOpenbisServiceFacade
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 | |
---|---|
void |
addAdHocVocabularyTerm(java.lang.Long vocabularyId,
NewVocabularyTerm term)
Adds new ad-hoc terms to a vocabulary starting from specified ordinal + 1. |
void |
addAdHocVocabularyTerm(ch.systemsx.cisd.openbis.generic.shared.basic.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. |
java.util.HashMap<ch.systemsx.cisd.openbis.generic.shared.basic.dto.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. |
Method Detail |
---|
WebAppSettings getWebAppSettings(java.lang.String webAppId)
webAppId
- The id of the custom web app to get the display settings for.void setWebAppSettings(WebAppSettings customDisplaySettings)
customDisplaySettings
- The new display settingsjava.util.List<Experiment> searchForExperiments(SearchCriteria searchCriteria)
java.util.List<Sample> searchForSamples(SearchCriteria searchCriteria)
searchForSamples(searchCritera, EnumSet.of(SampleFetchOption.PROPERTIES))
searchCriteria
- The sample metadata values to be matched against.java.util.List<Sample> searchForSamples(SearchCriteria searchCriteria, java.util.EnumSet<SampleFetchOption> fetchOptions)
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)
.java.util.List<DataSet> searchForDataSets(SearchCriteria searchCriteria)
searchCriteria
- the criteria used for searching.java.util.List<DataSet> listDataSets(java.util.List<Sample> samples, java.util.EnumSet<DataSet.Connections> connectionsToGet)
samples
- The samples for which we return attached data sets.@Deprecated void addAdHocVocabularyTerm(ch.systemsx.cisd.openbis.generic.shared.basic.TechId vocabularyId, java.lang.String code, java.lang.String label, java.lang.String description, java.lang.Long previousTermOrdinal)
addAdHocVocabularyTerm(Long, NewVocabularyTerm)
method
instead.
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.void addAdHocVocabularyTerm(java.lang.Long vocabularyId, NewVocabularyTerm term)
vocabularyId
- The id of vocabulary which should be extended.term
- the vocabulary term to be added.@Deprecated java.util.HashMap<ch.systemsx.cisd.openbis.generic.shared.basic.dto.Vocabulary,java.util.List<ControlledVocabularyPropertyType.VocabularyTerm>> getVocabularyTermsMap()
ISimpleOpenbisServiceFacade.listVocabularies()
method instead.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |