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

This session defines methods to receive asynchronous notifications on adds/changes to Subject 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 is closed.

The views defined in this session correspond to the views in the SubjectLookupSession.

MethodgetOntologyId
Description

Gets the Ontology Id associated with this session.

Returnosid.id.Idthe Ontology Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetOntology
Description

Gets the Ontology associated with this session.

Returnosid.ontology.Ontologythe Ontology associated with this session
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanRegisterForSubjectNotifications
Description

Tests if this user can register for Subject 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.
MethoduseFederatedOntologyView
Description

Federates the view for methods in this session. A federated view will include notifications for subjects in ontologies which are children of this ontology in the ontology hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedOntologyView
Description

Isolates the view for methods in this session. An isolated view restricts notifications to this ontology only.

CompliancemandatoryThis method is must be implemented.
MethodreliableSubjectNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodunreliableSubjectNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodacknowledgeSubjectNotification
Description

Acknowledge a subject notification.

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

Register for notifications of new subjects. SubjectReceiver.newSubjects() is invoked when a new subject is created.

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

Registers for notification of updated subjects. SubjectReceiver.changedSubjects() is invoked when a subject is changed.

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

Registers for notification of an updated subject. SubjectReceiver.changedSubjects() is invoked when the specified subject is changed.

Parametersosid.id.IdsubjectIdthe Id of the Subject to monitor
ErrorsNULL_ARGUMENT subjectId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedSubjects
Description

Registers for notification of deleted subjects. SubjectReceiver.deletedSubjects() is invoked when a subject is removed from this ontology.

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

Registers for notification of a deleted subject. SubjectReceiver.changedSubjects() is invoked when the specified subject is removed from this ontology.

Parametersosid.id.IdsubjectIdthe Id of the Subject to monitor
ErrorsNULL_ARGUMENT subjectid is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedSubjectHierarchy
Description

Registers for notification of an updated subject hierarchy structure. SubjectReceiver.changedChildOfSubjects() is invoked when a node experiences a change in its children.

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

Registers for notification of an updated subject hierarchy structure. SubjectReceiver.changedChildOfSubjects() is invoked when the specified node or any of its ancestors experiences a change in its children.

Parametersosid.id.IdsubjectIdthe Id of the Subject node to monitor
ErrorsNULL_ARGUMENT subjectId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedSubjectHierarchyForDescendants
Description

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

Parametersosid.id.IdsubjectIdthe Id of the Subject node to monitor
ErrorsNULL_ARGUMENT subjectId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.