OSID Logo
OSID Specifications
ontology batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.ontology.batch.OntologyBatchManager
Implementsosid.OsidManager
osid.ontology.batch.OntologyBatchProfile
Description

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
MethodgetSubjectBatchAdminSession
Description

Gets the OsidSession associated with the bulk subject administration service.

Returnosid.ontology.batch.SubjectBatchAdminSessiona SubjectBatchAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSubjectBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsSubjectBatchAdmin() is true.
MethodgetSubjectBatchAdminSessionForOntology
Description

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

Parametersosid.id.IdontologyIdthe Id of the Ontology
Returnosid.ontology.batch.SubjectBatchAdminSessiona SubjectBatchAdminSession
ErrorsNOT_FOUNDno Ontology found by the given Id
NULL_ARGUMENT ontologyId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSubjectBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsSubjectBatchAdmin() and supportsVisibleFederation() are true
MethodgetRelevancyBatchAdminSession
Description

Gets the OsidSession associated with the bulk relevancy administration service.

Returnosid.ontology.batch.RelevancyBatchAdminSessiona RelevancyBatchAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRelevancyBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsRelevancyBatchAdmin() is true.
MethodgetRelevancyBatchAdminSessionForOntology
Description

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

Parametersosid.id.IdontologyIdthe Id of the Ontology
Returnosid.ontology.batch.RelevancyBatchAdminSessiona RelevancyBatchAdminSession
ErrorsNOT_FOUNDno Ontology found by the given Id
NULL_ARGUMENT ontologyId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRelevancyBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsRelevancyBatchAdmin() and supportsVisibleFederation() are true
MethodgetOntologyBatchAdminSession
Description

Gets the OsidSession associated with the bulk ontology administration service.

Returnosid.ontology.batch.OntologyBatchAdminSessionan OntologyBatchAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsOntologyBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsOntologyBatchAdmin() is true.