Interface | osid.ontology.OntologyManager | ||
---|---|---|---|
Implements | osid.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:
| ||
Method | getSubjectLookupSession | ||
Description |
Gets the | ||
Return | osid.ontology.SubjectLookupSession | a SubjectLookupSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsSubjectLookup() is false | ||
Compliance | optional | This method must be implemented if supportsSubjectLookup()
is true. | |
Method | getSubjectLookupSessionForOntology | ||
Description |
Gets the | ||
Parameters | osid.id.Id | ontologyId | the Id of the ontology |
Return | osid.ontology.SubjectLookupSession | a SubjectLookupSession | |
Errors | NOT_FOUND | ontologyId not found | |
NULL_ARGUMENT | ontologyId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsSubjectLookup() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsSubjectLookup()
and supportsVisibleFederation() are true. | |
Method | getSubjectLookupSessionForId | ||
Description |
Gets the | ||
Parameters | osid.id.Id | id | an Id |
Return | osid.ontology.SubjectLookupSession | a SubjectLookupSession | |
Errors | NOT_FOUND | id not found | |
NULL_ARGUMENT | id is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsSubjectLookup() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsSubjectLookup()
and supportsVisibleFederation() are true. | |
Method | getSubjectQuerySession | ||
Description |
Gets the | ||
Return | osid.ontology.SubjectQuerySession | a SubjectQuerySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsSubjectQuery() is false | ||
Compliance | optional | This method must be implemented if supportsSubjectQuery() is
true. | |
Method | getSubjectQuerySessionForOntology | ||
Description |
Gets the | ||
Parameters | osid.id.Id | ontologyId | the Id of the ontology |
Return | osid.ontology.SubjectQuerySession | a SubjectQuerySession | |
Errors | NOT_FOUND | ontologyId not found | |
NULL_ARGUMENT | ontologyId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsSubjectQuery() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsSubjectQuery()
and supportsVisibleFederation() are true. | |
Method | getSubjectSearchSession | ||
Description |
Gets the | ||
Return | osid.ontology.SubjectSearchSession | a SubjectSearchSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsSubjectSearch() is false | ||
Compliance | optional | This method must be implemented if supportsSubjectSearch()
is true. | |
Method | getSubjectSearchSessionForOntology | ||
Description |
Gets the | ||
Parameters | osid.id.Id | ontologyId | the Id of the ontology |
Return | osid.ontology.SubjectSearchSession | a SubjectSearchSession | |
Errors | NOT_FOUND | ontologyId not found | |
NULL_ARGUMENT | ontologyId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsSubjectSearch() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsSubjectSearch()
and supportsVisibleFederation() are true. | |
Method | getSubjectAdminSession | ||
Description |
Gets the | ||
Return | osid.ontology.SubjectAdminSession | a SubjectAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsSubjectAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsSubjectAdmin() is
true. | |
Method | getSubjectAdminSessionForOntology | ||
Description |
Gets the | ||
Parameters | osid.id.Id | ontologyId | the Id of the ontology |
Return | osid.ontology.SubjectAdminSession | a SubjectAdminSession | |
Errors | NOT_FOUND | ontologyId not found | |
NULL_ARGUMENT | ontologyId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsSubjectAdmin() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsSubjectAdmin()
and supportsVisibleFederation() are true. | |
Method | getSubjectNotificationSession | ||
Description |
Gets the notification session for notifications pertaining to subject changes. | ||
Parameters | osid.ontology.SubjectReceiver | subjectReceiver | the subject receiver |
Return | osid.ontology.SubjectNotificationSession | a SubjectNotificationSession | |
Errors | NULL_ARGUMENT | subjectReceiver is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsSubjectNotification() is false | ||
Compliance | optional | This method must be implemented if supportsSubjectNotification()
is true. | |
Method | getSubjectNotificationSessionForOntology | ||
Description |
Gets the | ||
Parameters | osid.ontology.SubjectReceiver | subjectReceiver | the subject receiver |
osid.id.Id | ontologyId | the Id of the ontology | |
Return | osid.ontology.SubjectNotificationSession | a SubjectNotificationSession | |
Errors | NOT_FOUND | ontologyId not found | |
NULL_ARGUMENT | subjectReceiver or ontologyId is null
| ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsSubjectNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsSubjectNotification()
and supportsVisibleFederation() are true.
| |
Method | getSubjectHierarchySession | ||
Description |
Gets the session traversing subject hierarchies. | ||
Return | osid.ontology.SubjectHierarchySession | a SubjectHierarchySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsSubjectHierarchy() is false | ||
Compliance | optional | This method must be implemented if supportsSubjectHierarchy()
is true. | |
Method | getSubjectHierarchySessionForOntology | ||
Description |
Gets the | ||
Parameters | osid.id.Id | ontologyId | the Id of the ontology |
Return | osid.ontology.SubjectHierarchySession | a SubjectHierarchySession | |
Errors | NOT_FOUND | ontologyId not found | |
NULL_ARGUMENT | ontologyId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsSubjectHierarchy() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsSubjectHierarchy()
and supportsVisibleFederation() are true.
| |
Method | getSubjectHierarchySessionForId | ||
Description |
Gets the hierarchy session for the given | ||
Parameters | osid.id.Id | id | an Id |
Return | osid.ontology.SubjectHierarchySession | a SubjectHierarchySession | |
Errors | NOT_FOUND | id not found | |
NULL_ARGUMENT | id is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsSubjectHierarchy() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsSubjectHierarchy()
and supportsVisibleFederation() are true.
| |
Method | getSubjectHierarchyDesignSession | ||
Description |
Gets the session designing subject hierarchies. | ||
Return | osid.ontology.SubjectHierarchyDesignSession | a SubjectHierarchyDesignSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsSubjectHierarchyDesign() is false | ||
Compliance | optional | This method must be implemented if supportsSubjectHierarchyDesign()
is true. | |
Method | getSubjectHierarchyDesignSessionForOntology | ||
Description |
Gets the | ||
Parameters | osid.id.Id | ontologyId | the Id of the ontology |
Return | osid.ontology.SubjectHierarchyDesignSession | a SubjectHierarchyDesignSession | |
Errors | NOT_FOUND | ontologyId not found | |
NULL_ARGUMENT | ontologyId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsSubjectHierarchyDesign() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsSubjectHierarchyDesign()
and supportsVisibleFederation() are true.
| |
Method | getSubjectOntologySession | ||
Description |
Gets the session retrieving subject ontology mappings. | ||
Return | osid.ontology.SubjectOntologySession | a SubjectOntologySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsSubjectOntology() is false | ||
Compliance | optional | This method must be implemented if supportsSubjectOntology()
is true. | |
Method | getSubjectOntologyAssignmentSession | ||
Description |
Gets the session managing subject ontology mappings. | ||
Return | osid.ontology.SubjectOntologyAssignmentSession | a SubjectOntologyAssignmentSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsSubjectOntologyAssignment() is false | ||
Compliance | optional | This method must be implemented if
supportsSubjectOntologyAssignment() is true. | |
Method | getSubjectSmartOntologySession | ||
Description |
Gets the session managing subject smart ontologies. | ||
Parameters | osid.id.Id | ontologyId | the Id of the ontology |
Return | osid.ontology.SubjectSmartOntologySession | a SubjectSmartOntologySession | |
Errors | NOT_FOUND | ontologyId not found | |
NULL_ARGUMENT | ontologyId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsSubjectSmartOntology() is false | ||
Compliance | optional | This method must be implemented if supportsSubjectSmartOntology()
is true. | |
Method | getRelevancyLookupSession | ||
Description |
Gets the | ||
Return | osid.ontology.RelevancyLookupSession | a RelevancyLookupSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsRelevancyLookup() is false | ||
Compliance | optional | This method must be implemented if supportsRelevancyLookup()
is true. | |
Method | getRelevancyLookupSessionForOntology | ||
Description |
Gets the | ||
Parameters | osid.id.Id | ontologyId | the Id of the ontology |
Return | osid.ontology.RelevancyLookupSession | a RelevancyLookupSession | |
Errors | NOT_FOUND | ontologyId not found | |
NULL_ARGUMENT | ontologyId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsRelevancyLookup() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsRelevancyLookup()
and supportsVisibleFederation() are true. | |
Method | getRelevancyQuerySession | ||
Description |
Gets the | ||
Return | osid.ontology.RelevancyQuerySession | a RelevancyQuerySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsRelevancyQuery() is false | ||
Compliance | optional | This method must be implemented if supportsRelevancyQuery()
is true. | |
Method | getRelevancyQuerySessionForOntology | ||
Description |
Gets the | ||
Parameters | osid.id.Id | ontologyId | the Id of the ontology |
Return | osid.ontology.RelevancyQuerySession | a RelevancyQuerySession | |
Errors | NOT_FOUND | ontologyId not found | |
NULL_ARGUMENT | ontologyId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsRelevancyQuery() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsRelevancyQuery()
and supportsVisibleFederation() are true. | |
Method | getRelevancySearchSession | ||
Description |
Gets the | ||
Return | osid.ontology.RelevancySearchSession | a RelevancySearchSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsRelevancySearch() is false | ||
Compliance | optional | This method must be implemented if supportsRelevancySearch()
is true. | |
Method | getRelevancySearchSessionForOntology | ||
Description |
Gets the | ||
Parameters | osid.id.Id | ontologyId | the Id of the ontology |
Return | osid.ontology.RelevancySearchSession | a RelevancySearchSession | |
Errors | NOT_FOUND | ontologyId not found | |
NULL_ARGUMENT | ontologyId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsRelevancySearch() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsRelevancySearch()
and supportsVisibleFederation() are true. | |
Method | getRelevancyAdminSession | ||
Description |
Gets the | ||
Return | osid.ontology.RelevancyAdminSession | a RelvancyAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsRelevancyAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsRelevancyAdmin()
is true. | |
Method | getRelevancyAdminSessionForOntology | ||
Description |
Gets the | ||
Parameters | osid.id.Id | ontologyId | the Id of the ontology |
Return | osid.ontology.RelevancyAdminSession | a RelevancyAdminSession | |
Errors | NOT_FOUND | ontologyId not found | |
NULL_ARGUMENT | ontologyId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsRelevancyAdmin() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsRelevancyAdmin()
and supportsVisibleFederation() are true. | |
Method | getRelevancyNotificationSession | ||
Description |
Gets the notification session for notifications pertaining to relevancy changes. | ||
Parameters | osid.ontology.RelevancyReceiver | relevancyReceiver | the relevancy receiver |
Return | osid.ontology.RelevancyNotificationSession | a RelevancyNotificationSession | |
Errors | NULL_ARGUMENT | relevancyReceiver is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsRelevancyNotification() is false | ||
Compliance | optional | This method must be implemented if supportsRelevancyNotification()
is true. | |
Method | getRelevancyNotificationSessionForOntology | ||
Description |
Gets the | ||
Parameters | osid.ontology.RelevancyReceiver | relevancyReceiver | the subject receiver |
osid.id.Id | ontologyId | the Id of the ontology | |
Return | osid.ontology.RelevancyNotificationSession | a RelevancyNotificationSession | |
Errors | NOT_FOUND | ontologyId not found | |
NULL_ARGUMENT | relevancyReceiver or ontologyId is
null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsRelevancyNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsRelevancyNotification()
and supportsVisibleFederation() are true.
| |
Method | getRelevancyOntologySession | ||
Description |
Gets the session retrieving relevancy ontology mappings. | ||
Return | osid.ontology.RelevancyOntologySession | a RelevancyOntologySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsRelevancyOntology() is false | ||
Compliance | optional | This method must be implemented if supportsRelevancyOntology()
is true. | |
Method | getRelevancyOntologyAssignmentSession | ||
Description |
Gets the session managing relevancy ontology mappings. | ||
Return | osid.ontology.RelevancyOntologyAssignmentSession | a RelevancyOntologyAssignmentSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsRelevancyOntologyAssignment() is false | ||
Compliance | optional | This method must be implemented if
supportsRelevancyOntologyAssignment() is true. | |
Method | getRelevancySmartOntologySession | ||
Description |
Gets the session managing relevancy smart ontologies. | ||
Parameters | osid.id.Id | ontologyId | the Id of the ontology |
Return | osid.ontology.RelevancySmartOntologySession | a RelevancySmartOntologySession | |
Errors | NOT_FOUND | ontologyId not found | |
NULL_ARGUMENT | ontologyId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsRelevancySmartOntology() is false | ||
Compliance | optional | This method must be implemented if supportsRelevancySmartOntology()
is true. | |
Method | getOntologyLookupSession | ||
Description |
Gets the OsidSession associated with the ontology lookup service. | ||
Return | osid.ontology.OntologyLookupSession | an OntologyLookupSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsOntologyLookup() is false | ||
Compliance | optional | This method must be implemented if supportsOntologyLookup()
is true. | |
Method | getOntologyQuerySession | ||
Description |
Gets the OsidSession associated with the ontology query service. | ||
Return | osid.ontology.OntologyQuerySession | an OntologyQuerySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsOntologyQuery() is false | ||
Compliance | optional | This method must be implemented if supportsOntologyQuery()
is true. | |
Method | getOntologySearchSession | ||
Description |
Gets the OsidSession associated with the ontology search service. | ||
Return | osid.ontology.OntologySearchSession | an OntologySearchSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsOntologySearch() is false | ||
Compliance | optional | This method must be implemented if supportsOntologySearch()
is true. | |
Method | getOntologyAdminSession | ||
Description |
Gets the OsidSession associated with the ontology administration service. | ||
Return | osid.ontology.OntologyAdminSession | an OntologyAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsOntologyAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsOntologyAdmin()
is true. | |
Method | getOntologyNotificationSession | ||
Description |
Gets the notification session for notifications pertaining to ontology service changes. | ||
Parameters | osid.ontology.OntologyReceiver | ontologyReceiver | the ontology receiver |
Return | osid.ontology.OntologyNotificationSession | an OntologyNotificationSession | |
Errors | NULL_ARGUMENT | ontologyReceiver is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsOntologyNotification() is false | ||
Compliance | optional | This method must be implemented if supportsOntologyNotification()
is true. | |
Method | getOntologyHierarchySession | ||
Description |
Gets the session traversing ontology hierarchies. | ||
Return | osid.ontology.OntologyHierarchySession | an OntologyHierarchySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsOntologyHierarchy() is false | ||
Compliance | optional | This method must be implemented if supportsOntologyHierarchy()
is true. | |
Method | getOntologyHierarchyDesignSession | ||
Description |
Gets the session designing ontology hierarchies. | ||
Return | osid.ontology.OntologyHierarchyDesignSession | an OntologyHierarchyDesignSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsOntologyHierarchyDesign() is false | ||
Compliance | optional | This method must be implemented if supportsOntologyHierarchyDesign()
is true. | |
Method | getOntologyAssignmentSession | ||
Description |
Gets the session to assign | ||
Return | osid.ontology.OntologyAssignmentSession | an OntologyAssignmentSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsOntologyAssignment() is false | ||
Compliance | optional | This method must be implemented if supportsOntologyAssignment()
is true. | |
Method | getOntologyBatchManager | ||
Description |
Gets the ontology batch service. | ||
Return | osid.ontology.batch.OntologyBatchManager | an OntologyBatchManager | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsOntologyBatch() is false | ||
Compliance | optional | This method must be implemented if supportsOntologyBatch()
is true. | |
Method | getOntologyRulesManager | ||
Description |
Gets the ontology rules service. | ||
Return | osid.ontology.rules.OntologyRulesManager | an OntologyRulesManager | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsOntologyRules() is false | ||
Compliance | optional | This method must be implemented if supportsOntologyRules()
is true. |