OSID Logo
OSID Specifications
ontology package
Version 3.0.0
Release Candidate Preview
Interfaceosid.ontology.OntologyNotificationSession
Implementsosid.OsidSession
Description

This session defines methods to receive notifications on adds/changes to Ontology objects. This session is intended for consumers needing to synchronize their state with this service without the use of polling. Notifications are cancelled when this session i

MethodcanRegisterForOntologyNotifications
Description

Tests if this user can register for Ontology notifications. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer notification operations.

Returnboolean false if notification methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodreliableOntologyNotifications
Description

Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using acknowledgeOntologyNotification() .

CompliancemandatoryThis method is must be implemented.
MethodunreliableOntologyNotifications
Description

Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.

CompliancemandatoryThis method is must be implemented.
MethodacknowledgeOntologyNotification
Description

Acknowledge an ontology notification.

Parametersosid.id.IdnotificationIdthe Id of the notification
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewOntologies
Description

Register for notifications of new ontologies. OntologyReceiver.newOntologies() is invoked when a new Ontology is created.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedOntologies
Description

Registers for notification of updated ontologies. OntologyReceiver.changedOntologies() is invoked when an ontology is changed.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedOntology
Description

Registers for notification of an updated ontology. OntologyReceiver.changedOntologies() is invoked when the specified ontology is changed.

Parametersosid.id.IdontologyIdthe Id of the ontology to monitor
ErrorsNULL_ARGUMENT ontologyId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedOntologies
Description

Registers for notification of deleted ontologies. OntologyReceiver.deletedOntologies() is invoked when a calenedar is deleted.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedOntology
Description

Registers for notification of a deleted ontology. OntologyReceiver.deletedOntologies() is invoked when the specified ontology is deleted.

Parametersosid.id.IdontologyIdthe Id of the ontology to monitor
ErrorsNULL_ARGUMENT ontologyId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedOntologyHierarchy
Description

Registers for notification of an updated ontology hierarchy structure. OntologyReceiver.changedChildOfOntologies() is invoked when a node experiences a change in its children.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedOntologyHierarchyForAncestors
Description

OntologyReceiver.changedChildOfOntologiess() is invoked when the specified node or any of its ancestors experiences a change in its children.

Parametersosid.id.IdontologyIdthe Id of the Ontology node to monitor
ErrorsNULL_ARGUMENT ontologyId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedOntologyHierarchyForDescendants
Description

Registers for notification of an updated ontology hierarchy structure. OntologyReceiver.changedChildOfOntologies() is invoked when the specified node or any of its descendants experiences a change in its children.

Parametersosid.id.IdontologyIdthe Id of the Ontology node to monitor
ErrorsNULL_ARGUMENT ontologyId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.