org.osid.ontology.batch

Interface OntologyBatchAdminSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OntologyAdminSession, 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.

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasOntologies(AliasRequestList aliasRequests) Adds an Id to a Ontology for the purpose of creating compatibility.
CreateResponseList	createOntologies(OntologyBatchFormList ontologyForms) Creates a new set of Ontologies.
DeleteResponseList	deleteAllOntologies() Deletes all Ontologies.
DeleteResponseList	deleteOntologies(IdList ontologyIds) Deletes ontologies for the given Ids.
OntologyBatchFormList	getOntologyFormsForCreate(long number, Type[] ontologyRecordTypes) Gets the ontology forms for creating a bunch of new ontologies.
OntologyBatchFormList	getOntologyFormsForUpdate(IdList ontologyIds) Gets the ontology forms for updating an existing set of ontologies.
UpdateResponseList	updateOntologies(OntologyBatchFormList ontologyForms) Updates existing ontologies.

Methods inherited from interface org.osid.ontology.OntologyAdminSession

aliasOntology, canCreateOntologies, canCreateOntologyWithRecordTypes, canDeleteOntologies, canManageOntologyAliases, canUpdateOntologies, createOntology, deleteOntology, getOntologyFormForCreate, getOntologyFormForUpdate, updateOntology

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getOntologyFormsForCreate

OntologyBatchFormList getOntologyFormsForCreate(long number,
                                              Type[] ontologyRecordTypes)
                                                throws OperationFailedException,
                                                       PermissionDeniedException

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

Parameters:

number - the number of forms to retrieve

ontologyRecordTypes - array of ontology record types to be included in each create operation or an empty list if none

Returns:

the ontology forms

Throws:

NullArgumentException - ontologyRecordTypes is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - unable to request forms with given record types

Compliance:

mandatory - This method must be implemented.

createOntologies

CreateResponseList createOntologies(OntologyBatchFormList ontologyForms)
                                    throws OperationFailedException,
                                           PermissionDeniedException

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 .

Parameters:

ontologyForms - the ontology forms

Returns:

the create responses

Throws:

NullArgumentException - ontologyForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getOntologyFormsForUpdate

OntologyBatchFormList getOntologyFormsForUpdate(IdList ontologyIds)
                                                throws NotFoundException,
                                                       OperationFailedException,
                                                       PermissionDeniedException

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

Parameters:

ontologyIds - the Ids of the Ontology

Returns:

the ontology form

Throws:

NotFoundException - an ontologyId is not found

NullArgumentException - ontologyIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateOntologies

UpdateResponseList updateOntologies(OntologyBatchFormList ontologyForms)
                                    throws OperationFailedException,
                                           PermissionDeniedException

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 .

Parameters:

ontologyForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - ontologyForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllOntologies

DeleteResponseList deleteAllOntologies()
                                       throws OperationFailedException,
                                              PermissionDeniedException

Deletes all Ontologies.

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteOntologies

DeleteResponseList deleteOntologies(IdList ontologyIds)
                                    throws OperationFailedException,
                                           PermissionDeniedException

Deletes ontologies for the given Ids.

Parameters:

ontologyIds - the Ids of the ontologies to delete

Returns:

the delete responses

Throws:

NullArgumentException - ontologyIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasOntologies

AliasResponseList aliasOntologies(AliasRequestList aliasRequests)
                                  throws OperationFailedException,
                                         PermissionDeniedException

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.

Parameters:

aliasRequests - the alias requests

Returns:

the alias responses

Throws:

NullArgumentException - aliasRequests is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.