Package ch.systemsx.cisd.openbis.generic.server.jython.api.v1

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 Details

    • createNewExperimentType

      IExperimentType createNewExperimentType(String code)
      Create a new experiment type to register with the openBIS AS.
      Parameters:
      code - the experiment type's code.

    • getExperimentType

      IExperimentTypeImmutable getExperimentType(String code)
      Get an experiment type from the openBIS AS. Returns null if the experiment type does not exist.
      Returns:
      An experiment type or null

    • getOrCreateNewExperimentType

      IExperimentType getOrCreateNewExperimentType(String code)
      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

      ISampleType createNewSampleType(String code)
      Create a new sample type to register with the openBIS AS.
      Parameters:
      code - the sample type's code.

    • getSampleType

      ISampleTypeImmutable getSampleType(String code)
      Get a sample type from the openBIS AS. Returns null if the sample type does not exist.
      Returns:
      A sample type or null

    • getOrCreateNewSampleType

      ISampleType getOrCreateNewSampleType(String code)
      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

      IDataSetType createNewDataSetType(String code)
      Create a new data set type to register with the openBIS AS.
      Parameters:
      code - the data set type's code.

    • getDataSetType

      IDataSetTypeImmutable getDataSetType(String code)
      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

      IDataSetType getOrCreateNewDataSetType(String code)
      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

      IScriptImmutable getScript(String code)
      Get a script from the openBIS AS. Returns null if the script does not exist.
      Returns:
      A script or null

    • getOrCreateNewScript

      IScript getOrCreateNewScript(String code)
      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.

    • createNewPropertyType

      IPropertyType createNewPropertyType(String code, DataType dataType)
      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

      IPropertyTypeImmutable getPropertyType(String code)
      Get a property type from the openBIS AS. Returns null if the property type does not exist.
      Returns:
      A property type or null

    • getOrCreateNewPropertyType

      IPropertyType getOrCreateNewPropertyType(String code, DataType dataType)
      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

      IPropertyAssignment assignPropertyType(IEntityType entityType, IPropertyTypeImmutable propertyType)
      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, or IDataSetTypeImmutable.
      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.

    • createNewVocabulary

      IVocabulary createNewVocabulary(String code)
      Create a new sample type to register with the openBIS AS.
      Parameters:
      code - the sample type's code.

    • getVocabulary

      IVocabularyImmutable getVocabulary(String code)
      Get a vocabulary from the openBIS AS. Returns null if the vocabulary does not exist.
      Returns:
      A vocabulary or null

    • getOrCreateNewVocabulary

      IVocabulary getOrCreateNewVocabulary(String code)
      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

      IVocabularyTerm createNewVocabularyTerm(String code)
      Create a new vocabulary term. The resulting object can be added to a vocabulary via the IVocabulary.addTerm(IVocabularyTerm) method.
      Parameters:
      code - the vocabulary term's code

    • getVocabularyTerm

      IVocabularyTerm getVocabularyTerm(IVocabularyImmutable vocabulary, String vocabularyTermCode)
      Returns the vocabulary term with specified code from the specified vocabulary.
      Throws:
      IllegalArgumentException - if the specified vocabulary or term doesn't exists.

    • updateVocabularyTerm

      void updateVocabularyTerm(IVocabularyTerm term)
      Updates the specified vocabulary term.

    • createNewExternalDataManagementSystem

      IExternalDataManagementSystem createNewExternalDataManagementSystem(String code)
      Create a new external data management system to register with the openBIS AS.
      Parameters:
      code - the external data management system's code.

    • getExternalDataManagementSystem

      IExternalDataManagementSystemImmutable getExternalDataManagementSystem(String code)
      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

      IExternalDataManagementSystem getOrCreateNewExternalDataManagementSystem(String code)
      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.