org.osid.ontology.batch

Interface OntologyBatchManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OntologyBatchProfile, OsidManager, OsidProfile, Sourceable

public interface OntologyBatchManager
extends OsidManager, OntologyBatchProfile

The ontology batch manager provides access to ontology batch sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:

• SubjectBatchAdminSession: a session to create, modify and delete subjects in bulk
• RelevancyBatchSession: a session to create, modify and delete relevancies in bulk
• OntologyBatchAdminSession: a session to create, modify and delete ontologies in bulk

Method Summary

Methods

Modifier and Type	Method and Description
OntologyBatchAdminSession	getOntologyBatchAdminSession() Gets the OsidSession associated with the bulk ontology administration service.
RelevancyBatchAdminSession	getRelevancyBatchAdminSession() Gets the OsidSession associated with the bulk relevancy administration service.
RelevancyBatchAdminSession	getRelevancyBatchAdminSessionForOntology(Id ontologyId) Gets the OsidSession associated with the bulk relevancy administration service for the given ontology.
SubjectBatchAdminSession	getSubjectBatchAdminSession() Gets the OsidSession associated with the bulk subject administration service.
SubjectBatchAdminSession	getSubjectBatchAdminSessionForOntology(Id ontologyId) Gets the OsidSession associated with the bulk subject administration service for the given ontology.

Methods inherited from interface org.osid.OsidManager

changeBranch, initialize, rollbackService

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

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.ontology.batch.OntologyBatchProfile

supportsOntologyBatchAdmin, supportsRelevancyBatchAdmin, supportsSubjectBatchAdmin, supportsVisibleFederation

Methods inherited from interface org.osid.OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getSubjectBatchAdminSession

SubjectBatchAdminSession getSubjectBatchAdminSession()
                                                     throws OperationFailedException

Gets the OsidSession associated with the bulk subject administration service.

Returns:

a SubjectBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSubjectBatchAdmin() is false

Compliance:

optional - This method must be implemented if supportsSubjectBatchAdmin() is true.

getSubjectBatchAdminSessionForOntology

SubjectBatchAdminSession getSubjectBatchAdminSessionForOntology(Id ontologyId)
                                                                throws NotFoundException,
                                                                       OperationFailedException

Gets the OsidSession associated with the bulk subject administration service for the given ontology.

Parameters:

ontologyId - the Id of the Ontology

Returns:

a SubjectBatchAdminSession

Throws:

NotFoundException - no Ontology found by the given Id

NullArgumentException - ontologyId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSubjectBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsSubjectBatchAdmin() and supportsVisibleFederation() are true

getRelevancyBatchAdminSession

RelevancyBatchAdminSession getRelevancyBatchAdminSession()
                                                         throws OperationFailedException

Gets the OsidSession associated with the bulk relevancy administration service.

Returns:

a RelevancyBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsRelevancyBatchAdmin() is false

Compliance:

optional - This method must be implemented if supportsRelevancyBatchAdmin() is true.

getRelevancyBatchAdminSessionForOntology

RelevancyBatchAdminSession getRelevancyBatchAdminSessionForOntology(Id ontologyId)
                                                                    throws NotFoundException,
                                                                           OperationFailedException

Gets the OsidSession associated with the bulk relevancy administration service for the given ontology.

Parameters:

ontologyId - the Id of the Ontology

Returns:

a RelevancyBatchAdminSession

Throws:

NotFoundException - no Ontology found by the given Id

NullArgumentException - ontologyId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsRelevancyBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsRelevancyBatchAdmin() and supportsVisibleFederation() are true

getOntologyBatchAdminSession

OntologyBatchAdminSession getOntologyBatchAdminSession()
                                                       throws OperationFailedException

Gets the OsidSession associated with the bulk ontology administration service.

Returns:

an OntologyBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsOntologyBatchAdmin() is false

Compliance:

optional - This method must be implemented if supportsOntologyBatchAdmin() is true.