OSID Logo
OSID Specifications
ontology batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.ontology.batch.OntologyBatchAdminSession
Implementsosid.ontology.OntologyAdminSession
Description

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.

MethodgetOntologyFormsForCreate
Description

Gets the ontology forms for creating a bunch of new ontologies.

Parameterscardinalnumberthe number of forms to retrieve
osid.type.Type[]ontologyRecordTypesarray of ontology record types to be included in each create operation or an empty list if none
Returnosid.ontology.batch.OntologyBatchFormListthe ontology forms
ErrorsNULL_ARGUMENT ontologyRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateOntologies
Description

Creates a new set of Ontologies. This method returns an error if the entire operation fails. Otherwise, the status of an individual create operation is indicated in the BatchCreateResponse .

Parametersosid.ontology.batch.OntologyBatchFormListontologyFormsthe ontology forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT ontologyForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetOntologyFormsForUpdate
Description

Gets the ontology forms for updating an existing set of ontologies. A new ontology form should be requested for each update transaction.

Parametersosid.id.IdListontologyIdsthe Ids of the Ontology
Returnosid.ontology.batch.OntologyBatchFormListthe ontology form
ErrorsNOT_FOUNDan ontologyId is not found
NULL_ARGUMENT ontologyIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateOntologies
Description

Updates existing ontologies. This method returns an error if the entire operation fails. Otherwise, the status of an individual update operation is indicated in the BatchCreateResponse .

Parametersosid.ontology.batch.OntologyBatchFormListontologyFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT ontologyForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllOntologies
Description

Deletes all Ontologies.

Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteOntologies
Description

Deletes ontologies for the given Ids.

Parametersosid.id.IdListontologyIdsthe Ids of the ontologies to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT ontologyIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasOntologies
Description

Adds an Id to a Ontology for the purpose of creating compatibility. The primary Id of the Ontology is determined by the provider. The new Id is an alias to the primary Id. If the alias is a pointer to another ontology, it is reassigned to the given ontology Id.

Parametersosid.transaction.batch.AliasRequestListaliasRequeststhe alias requests
Returnosid.transaction.batch.AliasResponseListthe alias responses
ErrorsNULL_ARGUMENT aliasRequests is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.