OSID Logo
OSID Specifications
ontology package
Version 3.0.0
Release Candidate Preview
Interfaceosid.ontology.OntologyManager
Implementsosid.OsidManager
osid.ontology.OntologyProfile
Description

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

  • SubjectLookupSession: a session to look up subjects
  • SubjectQuerySession: a session to query subjects
  • SubjectSearchSession: a session to search subjects
  • SubjectAdminSession: a session to create, modify and delete subjects
  • SubjectNotificationSession: a session to receive messages pertaining to subject changes
  • SubjectHierarchySession: a session to traverse subject hierarchies
  • SubjectHierarchyDesignSession: a sesion to manage subject hierarchies
  • SubjectOntologySession: a session for retriieving subject and ontology mappings
  • SubjectOntologyAssignmentSession: a session for managing subject and ontology mappings
  • SubjectSmartOntologySession: a session to manage dynamic ontologies of subjects
  • RelevancyLookupSession: a session to look up subject relevancies
  • RelevancyQuerySession: a session to query subject relevancies
  • RelevancySearchSession: a session to search subject relevancies
  • RelevancyAdminSession: a session to create, modify and delete subject relevancies
  • RelevancyNotificationSession: a session to receive messages pertaining to subject relevancy changes
  • RelevancyOntologySession: a session for retriieving relevancy and ontology mappings
  • RelevancyOntologyAssignmentSession: a session for managing relevancy and ontology mappings
  • RelevancySmartOntologySession: a session to manage dynamic ontologies of relevancies
  • OntologyLookupSession: a session to lookup ontologies
  • OntologyQuerySession: a session to search ontologies
  • OntologySearchSession : a session to search ontologies
  • OntologyAdminSession : a session to create, modify and delete ontologies
  • OntologyNotificationSession : a session to receive messages pertaining to ontology changes
  • OntologyHierarchySession: a session to traverse the ontology hierarchy
  • OntologyHierarchyDesignSession: a session to manage the ontology hierarchy
MethodgetSubjectLookupSession
Description

Gets the OsidSession associated with the subject lookup service.

Returnosid.ontology.SubjectLookupSessiona SubjectLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSubjectLookup() is false
ComplianceoptionalThis method must be implemented if supportsSubjectLookup() is true.
MethodgetSubjectLookupSessionForOntology
Description

Gets the OsidSession associated with the subject lookup service for the given ontology.

Parametersosid.id.IdontologyIdthe Id of the ontology
Returnosid.ontology.SubjectLookupSession a SubjectLookupSession
ErrorsNOT_FOUND ontologyId not found
NULL_ARGUMENT ontologyId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsSubjectLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsSubjectLookup() and supportsVisibleFederation() are true.
MethodgetSubjectLookupSessionForId
Description

Gets the OsidSession associated with the subject lookup service for the given Id assigned using the OntologyAssignmentSession.

Parametersosid.id.Ididan Id
Returnosid.ontology.SubjectLookupSession a SubjectLookupSession
ErrorsNOT_FOUND id not found
NULL_ARGUMENT id is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsSubjectLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsSubjectLookup() and supportsVisibleFederation() are true.
MethodgetSubjectQuerySession
Description

Gets the OsidSession associated with the subject query service.

Returnosid.ontology.SubjectQuerySessiona SubjectQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSubjectQuery() is false
ComplianceoptionalThis method must be implemented if supportsSubjectQuery() is true.
MethodgetSubjectQuerySessionForOntology
Description

Gets the OsidSession associated with the subject query service for the given ontology.

Parametersosid.id.IdontologyIdthe Id of the ontology
Returnosid.ontology.SubjectQuerySessiona SubjectQuerySession
ErrorsNOT_FOUND ontologyId not found
NULL_ARGUMENT ontologyId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsSubjectQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsSubjectQuery() and supportsVisibleFederation() are true.
MethodgetSubjectSearchSession
Description

Gets the OsidSession associated with the subject search service.

Returnosid.ontology.SubjectSearchSessiona SubjectSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSubjectSearch() is false
ComplianceoptionalThis method must be implemented if supportsSubjectSearch() is true.
MethodgetSubjectSearchSessionForOntology
Description

Gets the OsidSession associated with the subject search service for the given ontology.

Parametersosid.id.IdontologyIdthe Id of the ontology
Returnosid.ontology.SubjectSearchSession a SubjectSearchSession
ErrorsNOT_FOUND ontologyId not found
NULL_ARGUMENT ontologyId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsSubjectSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsSubjectSearch() and supportsVisibleFederation() are true.
MethodgetSubjectAdminSession
Description

Gets the OsidSession associated with the subject administration service.

Returnosid.ontology.SubjectAdminSessiona SubjectAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSubjectAdmin() is false
ComplianceoptionalThis method must be implemented if supportsSubjectAdmin() is true.
MethodgetSubjectAdminSessionForOntology
Description

Gets the OsidSession associated with the subject admin service for the given ontology.

Parametersosid.id.IdontologyIdthe Id of the ontology
Returnosid.ontology.SubjectAdminSession a SubjectAdminSession
ErrorsNOT_FOUND ontologyId not found
NULL_ARGUMENT ontologyId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsSubjectAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsSubjectAdmin() and supportsVisibleFederation() are true.
MethodgetSubjectNotificationSession
Description

Gets the notification session for notifications pertaining to subject changes.

Parametersosid.ontology.SubjectReceiversubjectReceiverthe subject receiver
Returnosid.ontology.SubjectNotificationSessiona SubjectNotificationSession
ErrorsNULL_ARGUMENT subjectReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSubjectNotification() is false
ComplianceoptionalThis method must be implemented if supportsSubjectNotification() is true.
MethodgetSubjectNotificationSessionForOntology
Description

Gets the OsidSession associated with the subject notification service for the given ontology.

Parametersosid.ontology.SubjectReceiversubjectReceiverthe subject receiver
osid.id.IdontologyIdthe Id of the ontology
Returnosid.ontology.SubjectNotificationSession a SubjectNotificationSession
ErrorsNOT_FOUND ontologyId not found
NULL_ARGUMENT subjectReceiver or ontologyId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsSubjectNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsSubjectNotification() and supportsVisibleFederation() are true.
MethodgetSubjectHierarchySession
Description

Gets the session traversing subject hierarchies.

Returnosid.ontology.SubjectHierarchySessiona SubjectHierarchySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSubjectHierarchy() is false
ComplianceoptionalThis method must be implemented if supportsSubjectHierarchy() is true.
MethodgetSubjectHierarchySessionForOntology
Description

Gets the OsidSession associated with the subject heirarchy traversal service for the given ontology.

Parametersosid.id.IdontologyIdthe Id of the ontology
Returnosid.ontology.SubjectHierarchySessiona SubjectHierarchySession
ErrorsNOT_FOUND ontologyId not found
NULL_ARGUMENT ontologyId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsSubjectHierarchy() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsSubjectHierarchy() and supportsVisibleFederation() are true.
MethodgetSubjectHierarchySessionForId
Description

Gets the hierarchy session for the given Id assigned using the OntologyAssignmentSession.

Parametersosid.id.Ididan Id
Returnosid.ontology.SubjectHierarchySessiona SubjectHierarchySession
ErrorsNOT_FOUND id not found
NULL_ARGUMENT id is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsSubjectHierarchy() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsSubjectHierarchy() and supportsVisibleFederation() are true.
MethodgetSubjectHierarchyDesignSession
Description

Gets the session designing subject hierarchies.

Returnosid.ontology.SubjectHierarchyDesignSessiona SubjectHierarchyDesignSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSubjectHierarchyDesign() is false
ComplianceoptionalThis method must be implemented if supportsSubjectHierarchyDesign() is true.
MethodgetSubjectHierarchyDesignSessionForOntology
Description

Gets the OsidSession associated with the subject heirarchy design service for the given ontology.

Parametersosid.id.IdontologyIdthe Id of the ontology
Returnosid.ontology.SubjectHierarchyDesignSessiona SubjectHierarchyDesignSession
ErrorsNOT_FOUND ontologyId not found
NULL_ARGUMENT ontologyId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsSubjectHierarchyDesign() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsSubjectHierarchyDesign() and supportsVisibleFederation() are true.
MethodgetSubjectOntologySession
Description

Gets the session retrieving subject ontology mappings.

Returnosid.ontology.SubjectOntologySessiona SubjectOntologySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSubjectOntology() is false
ComplianceoptionalThis method must be implemented if supportsSubjectOntology() is true.
MethodgetSubjectOntologyAssignmentSession
Description

Gets the session managing subject ontology mappings.

Returnosid.ontology.SubjectOntologyAssignmentSessiona SubjectOntologyAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSubjectOntologyAssignment() is false
ComplianceoptionalThis method must be implemented if supportsSubjectOntologyAssignment() is true.
MethodgetSubjectSmartOntologySession
Description

Gets the session managing subject smart ontologies.

Parametersosid.id.IdontologyIdthe Id of the ontology
Returnosid.ontology.SubjectSmartOntologySessiona SubjectSmartOntologySession
ErrorsNOT_FOUND ontologyId not found
NULL_ARGUMENT ontologyId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsSubjectSmartOntology() is false
ComplianceoptionalThis method must be implemented if supportsSubjectSmartOntology() is true.
MethodgetRelevancyLookupSession
Description

Gets the OsidSession associated with the relevancy lookup service.

Returnosid.ontology.RelevancyLookupSessiona RelevancyLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRelevancyLookup() is false
ComplianceoptionalThis method must be implemented if supportsRelevancyLookup() is true.
MethodgetRelevancyLookupSessionForOntology
Description

Gets the OsidSession associated with the relevancy lookup service for the given ontology.

Parametersosid.id.IdontologyIdthe Id of the ontology
Returnosid.ontology.RelevancyLookupSession a RelevancyLookupSession
ErrorsNOT_FOUND ontologyId not found
NULL_ARGUMENT ontologyId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsRelevancyLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsRelevancyLookup() and supportsVisibleFederation() are true.
MethodgetRelevancyQuerySession
Description

Gets the OsidSession associated with the relevancy query service.

Returnosid.ontology.RelevancyQuerySessiona RelevancyQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRelevancyQuery() is false
ComplianceoptionalThis method must be implemented if supportsRelevancyQuery() is true.
MethodgetRelevancyQuerySessionForOntology
Description

Gets the OsidSession associated with the relevancy query service for the given ontology.

Parametersosid.id.IdontologyIdthe Id of the ontology
Returnosid.ontology.RelevancyQuerySession a RelevancyQuerySession
ErrorsNOT_FOUND ontologyId not found
NULL_ARGUMENT ontologyId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsRelevancyQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsRelevancyQuery() and supportsVisibleFederation() are true.
MethodgetRelevancySearchSession
Description

Gets the OsidSession associated with the relevancy search service.

Returnosid.ontology.RelevancySearchSessiona RelevancySearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRelevancySearch() is false
ComplianceoptionalThis method must be implemented if supportsRelevancySearch() is true.
MethodgetRelevancySearchSessionForOntology
Description

Gets the OsidSession associated with the relevancy search service for the given ontology.

Parametersosid.id.IdontologyIdthe Id of the ontology
Returnosid.ontology.RelevancySearchSession a RelevancySearchSession
ErrorsNOT_FOUND ontologyId not found
NULL_ARGUMENT ontologyId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsRelevancySearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsRelevancySearch() and supportsVisibleFederation() are true.
MethodgetRelevancyAdminSession
Description

Gets the OsidSession associated with the relevancy administration service.

Returnosid.ontology.RelevancyAdminSessiona RelvancyAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRelevancyAdmin() is false
ComplianceoptionalThis method must be implemented if supportsRelevancyAdmin() is true.
MethodgetRelevancyAdminSessionForOntology
Description

Gets the OsidSession associated with the relevancy admin service for the given ontology.

Parametersosid.id.IdontologyIdthe Id of the ontology
Returnosid.ontology.RelevancyAdminSession a RelevancyAdminSession
ErrorsNOT_FOUND ontologyId not found
NULL_ARGUMENT ontologyId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsRelevancyAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsRelevancyAdmin() and supportsVisibleFederation() are true.
MethodgetRelevancyNotificationSession
Description

Gets the notification session for notifications pertaining to relevancy changes.

Parametersosid.ontology.RelevancyReceiverrelevancyReceiverthe relevancy receiver
Returnosid.ontology.RelevancyNotificationSession a RelevancyNotificationSession
ErrorsNULL_ARGUMENT relevancyReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRelevancyNotification() is false
ComplianceoptionalThis method must be implemented if supportsRelevancyNotification() is true.
MethodgetRelevancyNotificationSessionForOntology
Description

Gets the OsidSession associated with the relevancy notification service for the given ontology.

Parametersosid.ontology.RelevancyReceiverrelevancyReceiverthe subject receiver
osid.id.IdontologyIdthe Id of the ontology
Returnosid.ontology.RelevancyNotificationSession a RelevancyNotificationSession
ErrorsNOT_FOUND ontologyId not found
NULL_ARGUMENT relevancyReceiver or ontologyId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsRelevancyNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsRelevancyNotification() and supportsVisibleFederation() are true.
MethodgetRelevancyOntologySession
Description

Gets the session retrieving relevancy ontology mappings.

Returnosid.ontology.RelevancyOntologySessiona RelevancyOntologySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRelevancyOntology() is false
ComplianceoptionalThis method must be implemented if supportsRelevancyOntology() is true.
MethodgetRelevancyOntologyAssignmentSession
Description

Gets the session managing relevancy ontology mappings.

Returnosid.ontology.RelevancyOntologyAssignmentSessiona RelevancyOntologyAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRelevancyOntologyAssignment() is false
ComplianceoptionalThis method must be implemented if supportsRelevancyOntologyAssignment() is true.
MethodgetRelevancySmartOntologySession
Description

Gets the session managing relevancy smart ontologies.

Parametersosid.id.IdontologyIdthe Id of the ontology
Returnosid.ontology.RelevancySmartOntologySessiona RelevancySmartOntologySession
ErrorsNOT_FOUND ontologyId not found
NULL_ARGUMENT ontologyId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsRelevancySmartOntology() is false
ComplianceoptionalThis method must be implemented if supportsRelevancySmartOntology() is true.
MethodgetOntologyLookupSession
Description

Gets the OsidSession associated with the ontology lookup service.

Returnosid.ontology.OntologyLookupSessionan OntologyLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsOntologyLookup() is false
ComplianceoptionalThis method must be implemented if supportsOntologyLookup() is true.
MethodgetOntologyQuerySession
Description

Gets the OsidSession associated with the ontology query service.

Returnosid.ontology.OntologyQuerySessionan OntologyQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsOntologyQuery() is false
ComplianceoptionalThis method must be implemented if supportsOntologyQuery() is true.
MethodgetOntologySearchSession
Description

Gets the OsidSession associated with the ontology search service.

Returnosid.ontology.OntologySearchSessionan OntologySearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsOntologySearch() is false
ComplianceoptionalThis method must be implemented if supportsOntologySearch() is true.
MethodgetOntologyAdminSession
Description

Gets the OsidSession associated with the ontology administration service.

Returnosid.ontology.OntologyAdminSessionan OntologyAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsOntologyAdmin() is false
ComplianceoptionalThis method must be implemented if supportsOntologyAdmin() is true.
MethodgetOntologyNotificationSession
Description

Gets the notification session for notifications pertaining to ontology service changes.

Parametersosid.ontology.OntologyReceiverontologyReceiverthe ontology receiver
Returnosid.ontology.OntologyNotificationSessionan OntologyNotificationSession
ErrorsNULL_ARGUMENT ontologyReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsOntologyNotification() is false
ComplianceoptionalThis method must be implemented if supportsOntologyNotification() is true.
MethodgetOntologyHierarchySession
Description

Gets the session traversing ontology hierarchies.

Returnosid.ontology.OntologyHierarchySessionan OntologyHierarchySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsOntologyHierarchy() is false
ComplianceoptionalThis method must be implemented if supportsOntologyHierarchy() is true.
MethodgetOntologyHierarchyDesignSession
Description

Gets the session designing ontology hierarchies.

Returnosid.ontology.OntologyHierarchyDesignSessionan OntologyHierarchyDesignSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsOntologyHierarchyDesign() is false
ComplianceoptionalThis method must be implemented if supportsOntologyHierarchyDesign() is true.
MethodgetOntologyAssignmentSession
Description

Gets the session to assign Ids to ontologies.

Returnosid.ontology.OntologyAssignmentSessionan OntologyAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsOntologyAssignment() is false
ComplianceoptionalThis method must be implemented if supportsOntologyAssignment() is true.
MethodgetOntologyBatchManager
Description

Gets the ontology batch service.

Returnosid.ontology.batch.OntologyBatchManageran OntologyBatchManager
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsOntologyBatch() is false
ComplianceoptionalThis method must be implemented if supportsOntologyBatch() is true.
MethodgetOntologyRulesManager
Description

Gets the ontology rules service.

Returnosid.ontology.rules.OntologyRulesManageran OntologyRulesManager
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsOntologyRules() is false
ComplianceoptionalThis method must be implemented if supportsOntologyRules() is true.