Interface | osid.ontology.SubjectNotificationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods to receive asynchronous
notifications on adds/changes to The views defined in this session correspond to the views
in the | ||
Method | getOntologyId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Ontology Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getOntology | ||
Description |
Gets the | ||
Return | osid.ontology.Ontology | the Ontology associated with this session | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canRegisterForSubjectNotifications | ||
Description |
Tests if this user can register for | ||
Return | boolean | false if notification methods are not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useFederatedOntologyView | ||
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. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedOntologyView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts notifications to this ontology only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | reliableSubjectNotifications | ||
Description |
Reliable notifications are desired. In reliable mode,
notifications are to be acknowledged using | ||
Compliance | mandatory | This method is must be implemented. | |
Method | unreliableSubjectNotifications | ||
Description |
Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | acknowledgeSubjectNotification | ||
Description |
Acknowledge a subject notification. | ||
Parameters | osid.id.Id | notificationId | the Id of the notification |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewSubjects | ||
Description |
Register for notifications of new subjects. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedSubjects | ||
Description |
Registers for notification of updated subjects. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedSubject | ||
Description |
Registers for notification of an updated subject.
| ||
Parameters | osid.id.Id | subjectId | the Id of the Subject to monitor |
Errors | NULL_ARGUMENT | subjectId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedSubjects | ||
Description |
Registers for notification of deleted subjects. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedSubject | ||
Description |
Registers for notification of a deleted subject. | ||
Parameters | osid.id.Id | subjectId | the Id of the Subject to monitor |
Errors | NULL_ARGUMENT | subjectid is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedSubjectHierarchy | ||
Description |
Registers for notification of an updated subject
hierarchy structure. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedSubjectHierarchyForAncestors | ||
Description |
Registers for notification of an updated subject
hierarchy structure. | ||
Parameters | osid.id.Id | subjectId | the Id of the Subject node to monitor |
Errors | NULL_ARGUMENT | subjectId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedSubjectHierarchyForDescendants | ||
Description |
Registers for notification of an updated subject
hierarchy structure. | ||
Parameters | osid.id.Id | subjectId | the Id of the Subject node to monitor |
Errors | NULL_ARGUMENT | subjectId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |