Interface IMasterDataRegistrationTransaction
- All Known Implementing Classes:
MasterDataRegistrationTransaction
public interface IMasterDataRegistrationTransaction
API for master data registration. Offers methods for creation and retrieval of openBIS types, property assignments, vocabularies etc.
-
Method Summary
Modifier and TypeMethodDescriptionassignPropertyType(IEntityType entityType, IPropertyTypeImmutable propertyType) Assigns a property type to an entity type.createNewDataSetType(String code) Create a new data set type to register with the openBIS AS.Create a new experiment type to register with the openBIS AS.Create a new external data management system to register with the openBIS AS.Create a new file format type to register with the openBIS AS.createNewMaterialType(String code) Create a new material type to register with the openBIS AS.createNewPropertyType(String code, DataType dataType) Create a new property type to register with the openBIS AS.createNewSampleType(String code) Create a new sample type to register with the openBIS AS.createNewVocabulary(String code) Create a new sample type to register with the openBIS AS.Create a new vocabulary term.getDataSetType(String code) Get a data set type from the openBIS AS.getExperimentType(String code) Get an experiment type from the openBIS AS.Get an external data management system from the openBIS AS.getFileFormatType(String code) Get a file format type from the openBIS AS.getMaterialType(String code) Get a material type from the openBIS AS.Gets or creates data set type from the openBIS AS.Gets or creates experiment type from the openBIS AS.Gets or creates external data management system from the openBIS AS.Gets or creates file format type from the openBIS AS.Gets or creates material type from the openBIS AS.getOrCreateNewPropertyType(String code, DataType dataType) Gets or creates property type from the openBIS AS.Gets or creates sample type from the openBIS AS.getOrCreateNewScript(String code) Gets or creates a script from the openBIS AS.Gets or creates vocabulary type from the openBIS AS.getPropertyType(String code) Get a property type from the openBIS AS.getSampleType(String code) Get a sample type from the openBIS AS.Get a script from the openBIS AS.getVocabulary(String code) Get a vocabulary from the openBIS AS.getVocabularyTerm(IVocabularyImmutable vocabulary, String vocabularyTermCode) Returns the vocabulary term with specified code from the specified vocabulary.Return all data set types existing in the openBIS AS.Return all experiment types existing in the openBIS AS.Return all external data management systems existing in the openBIS AS.Return all file format types existing in the openBIS AS.Return all material types existing in the openBIS AS.Return a list of all existing property assignments.Return all property types existing in the openBIS AS.Return all sample types existing in the openBIS AS.Return all scripts existing in the openBIS AS.Return all vocabularies existing in the openBIS AS.voidUpdates the specified vocabulary term.
-
Method Details
-
createNewExperimentType
Create a new experiment type to register with the openBIS AS.- Parameters:
code- the experiment type's code.
-
getExperimentType
Get an experiment type from the openBIS AS. Returns null if the experiment type does not exist.- Returns:
- An experiment type or null
-
getOrCreateNewExperimentType
Gets or creates experiment type from the openBIS AS.- Returns:
- the already existing type or a freshly created one if it doesn't exist. Setter methods on the returned type are ignored if the type already exists.
-
listExperimentTypes
List<IExperimentTypeImmutable> listExperimentTypes()Return all experiment types existing in the openBIS AS. -
createNewSampleType
Create a new sample type to register with the openBIS AS.- Parameters:
code- the sample type's code.
-
getSampleType
Get a sample type from the openBIS AS. Returns null if the sample type does not exist.- Returns:
- A sample type or null
-
getOrCreateNewSampleType
Gets or creates sample type from the openBIS AS.- Returns:
- the already existing type or a freshly created one if it doesn't exist. Setter methods on the returned type are ignored if the type already exists.
-
listSampleTypes
List<ISampleTypeImmutable> listSampleTypes()Return all sample types existing in the openBIS AS. -
createNewDataSetType
Create a new data set type to register with the openBIS AS.- Parameters:
code- the data set type's code.
-
getDataSetType
Get a data set type from the openBIS AS. Returns null if the data set type does not exist.- Returns:
- A data set type or null
-
getOrCreateNewDataSetType
Gets or creates data set type from the openBIS AS.- Returns:
- the already existing type or a freshly created one if it doesn't exist. Setter methods on the returned type are ignored if the type already exists.
-
listDataSetTypes
List<IDataSetTypeImmutable> listDataSetTypes()Return all data set types existing in the openBIS AS. -
getScript
Get a script from the openBIS AS. Returns null if the script does not exist.- Returns:
- A script or null
-
getOrCreateNewScript
Gets or creates a script from the openBIS AS.- Returns:
- the already existing script or a freshly created one if it doesn't exist. Setter methods on the returned script are ignored if the script already exists.
-
listScripts
List<IScriptImmutable> listScripts()Return all scripts existing in the openBIS AS. -
createNewMaterialType
Create a new material type to register with the openBIS AS.- Parameters:
code- the material type's code.
-
getMaterialType
Get a material type from the openBIS AS. Returns null if the material type does not exist.- Returns:
- A material type or null
-
getOrCreateNewMaterialType
Gets or creates material type from the openBIS AS.- Returns:
- the already existing type or a freshly created one if it doesn't exist. Setter methods on the returned type are ignored if the type already exists.
-
listMaterialTypes
List<IMaterialTypeImmutable> listMaterialTypes()Return all material types existing in the openBIS AS. -
createNewPropertyType
Create a new property type to register with the openBIS AS.- Parameters:
code- the property type's code.dataType- the data type of the property
-
getPropertyType
Get a property type from the openBIS AS. Returns null if the property type does not exist.- Returns:
- A property type or null
-
getOrCreateNewPropertyType
Gets or creates property type from the openBIS AS.- Parameters:
dataType- the data type of the property in case it has to be created.- Returns:
- the already existing type or a freshly created one if it doesn't exist. Setter methods on the returned type are ignored if the type already exists.
-
listPropertyTypes
List<IPropertyTypeImmutable> listPropertyTypes()Return all property types existing in the openBIS AS. -
assignPropertyType
Assigns a property type to an entity type. If the assignment is already established an object is returned where all setter method invocations are silently be ignored.- Parameters:
entityType- One of IExperimentTypeImmutable, ISampleTypeImmutable, IDataSetTypeImmutable, or IMaterialTypeImmutable.propertyType- The property type to assign to the entity type.- Returns:
- An object representing the assignment.
-
listPropertyAssignments
List<IPropertyAssignmentImmutable> listPropertyAssignments()Return a list of all existing property assignments. -
createNewFileFormatType
Create a new file format type to register with the openBIS AS.- Parameters:
code- the file format type's code.
-
getFileFormatType
Get a file format type from the openBIS AS. Returns null if the file format type does not exist.- Returns:
- A file format type or null
-
getOrCreateNewFileFormatType
Gets or creates file format type from the openBIS AS.- Returns:
- the already existing type or a freshly created one if it doesn't exist. Setter methods on the returned type are ignored if the type already exists.
-
listFileFormatTypes
List<IFileFormatTypeImmutable> listFileFormatTypes()Return all file format types existing in the openBIS AS. -
createNewVocabulary
Create a new sample type to register with the openBIS AS.- Parameters:
code- the sample type's code.
-
getVocabulary
Get a vocabulary from the openBIS AS. Returns null if the vocabulary does not exist.- Returns:
- A vocabulary or null
-
getOrCreateNewVocabulary
Gets or creates vocabulary type from the openBIS AS.- Returns:
- the already existing type or a freshly created one if it doesn't exist. Setter methods on the returned type are ignored if the type already exists.
-
listVocabularies
List<IVocabularyImmutable> listVocabularies()Return all vocabularies existing in the openBIS AS. -
createNewVocabularyTerm
Create a new vocabulary term. The resulting object can be added to a vocabulary via theIVocabulary.addTerm(IVocabularyTerm)method.- Parameters:
code- the vocabulary term's code
-
getVocabularyTerm
Returns the vocabulary term with specified code from the specified vocabulary.- Throws:
IllegalArgumentException- if the specified vocabulary or term doesn't exists.
-
updateVocabularyTerm
Updates the specified vocabulary term. -
createNewExternalDataManagementSystem
Create a new external data management system to register with the openBIS AS.- Parameters:
code- the external data management system's code.
-
getExternalDataManagementSystem
Get an external data management system from the openBIS AS. Returns null if the external data management system does not exist.- Returns:
- An external data management system or null
-
getOrCreateNewExternalDataManagementSystem
Gets or creates external data management system from the openBIS AS.- Returns:
- the already existing system or a freshly created one if it doesn't exist. Setter methods on the returned type are ignored if the type already exists.
-
listExternalDataManagementSystems
List<IExternalDataManagementSystemImmutable> listExternalDataManagementSystems()Return all external data management systems existing in the openBIS AS.
-