Interface OntologyBatchAdminSession

All Superinterfaces:
AutoCloseable, Closeable, OntologyAdminSession, OsidSession, OsidSession
public interface OntologyBatchAdminSession extends OntologyAdminSession

This session creates, updates, and deletes Ontologies in bulk. The data for create and update is provided by the consumer via the form object. OsidForms are requested for each create or update and may not be reused.

Create and update operations differ in their usage. To create an Ontology , an OntologyForm is requested using getOntologyFormsForCreate() specifying the desired record Types or none if no record Types are needed. Each of the returned OntologyForms will indicate that it is to be used with a create operation and can be used to examine metdata or validate data prior to creation. Once an OntologyForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each OntologyForm corresponds to an attempted transaction.

The OntologyForms returned from getOntologyFormsForCreate() may be linked to the originating request through the peer Ids of the OntologyForm . In the case where there may be duplicates, any OntologyForm of the same peer Ids may be used for a create operation.

Once a batch of OntologyForms are submitted for create, a CreateResponse is returned for each OntologyForm , although the ordering is not defined. Only errors that pertain to the entire create operation are returned from createOntologies() , errors specific to an individual OntologyForm are indicated in the corresponding CreateResponse . CreateResponses may be linked to the originating OntologyForm through the OntologyForm Id .

For updates, OntologyForms are requested to the Ontology Id that is to be updated using getOntologyFormsForUpdate() where the reference Id in the OntologyForm may be used to link the request. Similarly, the OntologyForm has metadata about the data that can be updated and it can perform validation before submitting the update. The OntologyForm can only be used once for a successful update and cannot be reused.

Once a batch of OntologyForms are submitted for update, an UpdateResponse is returned for each OntologyForm , although the ordering is not defined. Only errors that pertain to the entire update operation are returned from updateOntologies() , errors specific to an individual OntologyForm are indicated in the corresponding UpdateResponse . UpdateResponses may be linked to the originating OntologyForm through the OntologyForm Id .

The delete operations delete Ontologies in bulk. Bulk delete operations return the results in DeleteResponses .