Class MasterDataRegistrationTransaction
java.lang.Object
ch.systemsx.cisd.openbis.generic.server.jython.api.v1.impl.MasterDataRegistrationTransaction
- All Implemented Interfaces:
IMasterDataRegistrationTransaction
public class MasterDataRegistrationTransaction
extends Object
implements IMasterDataRegistrationTransaction
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionassignPropertyType(IEntityType entityType, IPropertyTypeImmutable propertyType) Assigns a property type to an entity type.voidcommit()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.booleanReturn 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.
-
Constructor Details
-
MasterDataRegistrationTransaction
-
-
Method Details
-
getTransactionErrors
-
hasErrors
public boolean hasErrors() -
createNewExperimentType
Description copied from interface:IMasterDataRegistrationTransactionCreate a new experiment type to register with the openBIS AS.- Specified by:
createNewExperimentTypein interfaceIMasterDataRegistrationTransaction- Parameters:
code- the experiment type's code.
-
getExperimentType
Description copied from interface:IMasterDataRegistrationTransactionGet an experiment type from the openBIS AS. Returns null if the experiment type does not exist.- Specified by:
getExperimentTypein interfaceIMasterDataRegistrationTransaction- Returns:
- An experiment type or null
-
getOrCreateNewExperimentType
Description copied from interface:IMasterDataRegistrationTransactionGets or creates experiment type from the openBIS AS.- Specified by:
getOrCreateNewExperimentTypein interfaceIMasterDataRegistrationTransaction- 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
Description copied from interface:IMasterDataRegistrationTransactionReturn all experiment types existing in the openBIS AS.- Specified by:
listExperimentTypesin interfaceIMasterDataRegistrationTransaction
-
createNewSampleType
Description copied from interface:IMasterDataRegistrationTransactionCreate a new sample type to register with the openBIS AS.- Specified by:
createNewSampleTypein interfaceIMasterDataRegistrationTransaction- Parameters:
code- the sample type's code.
-
getSampleType
Description copied from interface:IMasterDataRegistrationTransactionGet a sample type from the openBIS AS. Returns null if the sample type does not exist.- Specified by:
getSampleTypein interfaceIMasterDataRegistrationTransaction- Returns:
- A sample type or null
-
getOrCreateNewSampleType
Description copied from interface:IMasterDataRegistrationTransactionGets or creates sample type from the openBIS AS.- Specified by:
getOrCreateNewSampleTypein interfaceIMasterDataRegistrationTransaction- 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
Description copied from interface:IMasterDataRegistrationTransactionReturn all sample types existing in the openBIS AS.- Specified by:
listSampleTypesin interfaceIMasterDataRegistrationTransaction
-
createNewDataSetType
Description copied from interface:IMasterDataRegistrationTransactionCreate a new data set type to register with the openBIS AS.- Specified by:
createNewDataSetTypein interfaceIMasterDataRegistrationTransaction- Parameters:
code- the data set type's code.
-
getDataSetType
Description copied from interface:IMasterDataRegistrationTransactionGet a data set type from the openBIS AS. Returns null if the data set type does not exist.- Specified by:
getDataSetTypein interfaceIMasterDataRegistrationTransaction- Returns:
- A data set type or null
-
getOrCreateNewDataSetType
Description copied from interface:IMasterDataRegistrationTransactionGets or creates data set type from the openBIS AS.- Specified by:
getOrCreateNewDataSetTypein interfaceIMasterDataRegistrationTransaction- 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
Description copied from interface:IMasterDataRegistrationTransactionReturn all data set types existing in the openBIS AS.- Specified by:
listDataSetTypesin interfaceIMasterDataRegistrationTransaction
-
getScript
Description copied from interface:IMasterDataRegistrationTransactionGet a script from the openBIS AS. Returns null if the script does not exist.- Specified by:
getScriptin interfaceIMasterDataRegistrationTransaction- Returns:
- A script or null
-
getOrCreateNewScript
Description copied from interface:IMasterDataRegistrationTransactionGets or creates a script from the openBIS AS.- Specified by:
getOrCreateNewScriptin interfaceIMasterDataRegistrationTransaction- 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
Description copied from interface:IMasterDataRegistrationTransactionReturn all scripts existing in the openBIS AS.- Specified by:
listScriptsin interfaceIMasterDataRegistrationTransaction
-
createNewMaterialType
Description copied from interface:IMasterDataRegistrationTransactionCreate a new material type to register with the openBIS AS.- Specified by:
createNewMaterialTypein interfaceIMasterDataRegistrationTransaction- Parameters:
code- the material type's code.
-
getMaterialType
Description copied from interface:IMasterDataRegistrationTransactionGet a material type from the openBIS AS. Returns null if the material type does not exist.- Specified by:
getMaterialTypein interfaceIMasterDataRegistrationTransaction- Returns:
- A material type or null
-
getOrCreateNewMaterialType
Description copied from interface:IMasterDataRegistrationTransactionGets or creates material type from the openBIS AS.- Specified by:
getOrCreateNewMaterialTypein interfaceIMasterDataRegistrationTransaction- 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
Description copied from interface:IMasterDataRegistrationTransactionReturn all material types existing in the openBIS AS.- Specified by:
listMaterialTypesin interfaceIMasterDataRegistrationTransaction
-
createNewFileFormatType
Description copied from interface:IMasterDataRegistrationTransactionCreate a new file format type to register with the openBIS AS.- Specified by:
createNewFileFormatTypein interfaceIMasterDataRegistrationTransaction- Parameters:
code- the file format type's code.
-
getFileFormatType
Description copied from interface:IMasterDataRegistrationTransactionGet a file format type from the openBIS AS. Returns null if the file format type does not exist.- Specified by:
getFileFormatTypein interfaceIMasterDataRegistrationTransaction- Returns:
- A file format type or null
-
getOrCreateNewFileFormatType
Description copied from interface:IMasterDataRegistrationTransactionGets or creates file format type from the openBIS AS.- Specified by:
getOrCreateNewFileFormatTypein interfaceIMasterDataRegistrationTransaction- 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
Description copied from interface:IMasterDataRegistrationTransactionReturn all file format types existing in the openBIS AS.- Specified by:
listFileFormatTypesin interfaceIMasterDataRegistrationTransaction
-
createNewPropertyType
Description copied from interface:IMasterDataRegistrationTransactionCreate a new property type to register with the openBIS AS.- Specified by:
createNewPropertyTypein interfaceIMasterDataRegistrationTransaction- Parameters:
code- the property type's code.dataType- the data type of the property
-
getPropertyType
Description copied from interface:IMasterDataRegistrationTransactionGet a property type from the openBIS AS. Returns null if the property type does not exist.- Specified by:
getPropertyTypein interfaceIMasterDataRegistrationTransaction- Returns:
- A property type or null
-
getOrCreateNewPropertyType
Description copied from interface:IMasterDataRegistrationTransactionGets or creates property type from the openBIS AS.- Specified by:
getOrCreateNewPropertyTypein interfaceIMasterDataRegistrationTransactiondataType- 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
Description copied from interface:IMasterDataRegistrationTransactionReturn all property types existing in the openBIS AS.- Specified by:
listPropertyTypesin interfaceIMasterDataRegistrationTransaction
-
assignPropertyType
public IPropertyAssignment assignPropertyType(IEntityType entityType, IPropertyTypeImmutable propertyType) Description copied from interface:IMasterDataRegistrationTransactionAssigns 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.- Specified by:
assignPropertyTypein interfaceIMasterDataRegistrationTransaction- 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
Description copied from interface:IMasterDataRegistrationTransactionReturn a list of all existing property assignments.- Specified by:
listPropertyAssignmentsin interfaceIMasterDataRegistrationTransaction
-
createNewVocabularyTerm
Description copied from interface:IMasterDataRegistrationTransactionCreate a new vocabulary term. The resulting object can be added to a vocabulary via theIVocabulary.addTerm(IVocabularyTerm)method.- Specified by:
createNewVocabularyTermin interfaceIMasterDataRegistrationTransaction- Parameters:
code- the vocabulary term's code
-
createNewVocabulary
Description copied from interface:IMasterDataRegistrationTransactionCreate a new sample type to register with the openBIS AS.- Specified by:
createNewVocabularyin interfaceIMasterDataRegistrationTransaction- Parameters:
code- the sample type's code.
-
getVocabularyTerm
public IVocabularyTerm getVocabularyTerm(IVocabularyImmutable vocabulary, String vocabularyTermCode) Description copied from interface:IMasterDataRegistrationTransactionReturns the vocabulary term with specified code from the specified vocabulary.- Specified by:
getVocabularyTermin interfaceIMasterDataRegistrationTransaction
-
updateVocabularyTerm
Description copied from interface:IMasterDataRegistrationTransactionUpdates the specified vocabulary term.- Specified by:
updateVocabularyTermin interfaceIMasterDataRegistrationTransaction
-
getVocabulary
Description copied from interface:IMasterDataRegistrationTransactionGet a vocabulary from the openBIS AS. Returns null if the vocabulary does not exist.- Specified by:
getVocabularyin interfaceIMasterDataRegistrationTransaction- Returns:
- A vocabulary or null
-
getOrCreateNewVocabulary
Description copied from interface:IMasterDataRegistrationTransactionGets or creates vocabulary type from the openBIS AS.- Specified by:
getOrCreateNewVocabularyin interfaceIMasterDataRegistrationTransaction- 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
Description copied from interface:IMasterDataRegistrationTransactionReturn all vocabularies existing in the openBIS AS.- Specified by:
listVocabulariesin interfaceIMasterDataRegistrationTransaction
-
createNewExternalDataManagementSystem
Description copied from interface:IMasterDataRegistrationTransactionCreate a new external data management system to register with the openBIS AS.- Specified by:
createNewExternalDataManagementSystemin interfaceIMasterDataRegistrationTransaction- Parameters:
code- the external data management system's code.
-
getExternalDataManagementSystem
Description copied from interface:IMasterDataRegistrationTransactionGet an external data management system from the openBIS AS. Returns null if the external data management system does not exist.- Specified by:
getExternalDataManagementSystemin interfaceIMasterDataRegistrationTransaction- Returns:
- An external data management system or null
-
getOrCreateNewExternalDataManagementSystem
Description copied from interface:IMasterDataRegistrationTransactionGets or creates external data management system from the openBIS AS.- Specified by:
getOrCreateNewExternalDataManagementSystemin interfaceIMasterDataRegistrationTransaction- 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
Description copied from interface:IMasterDataRegistrationTransactionReturn all external data management systems existing in the openBIS AS.- Specified by:
listExternalDataManagementSystemsin interfaceIMasterDataRegistrationTransaction
-
commit
public void commit()
-