Interface | osid.subscription.PublisherNotificationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods to receive notifications on
adds/changes to Notifications are triggered with changes to the | ||
Method | canRegisterForPublisherNotifications | ||
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 | reliablePublisherNotifications | ||
Description |
Reliable notifications are desired. In reliable mode,
notifications are to be acknowledged using | ||
Compliance | mandatory | This method is must be implemented. | |
Method | unreliablePublisherNotifications | ||
Description |
Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | acknowledgePublisherNotification | ||
Description |
Acknowledge a publisher 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 | registerForNewPublishers | ||
Description |
Register for notifications of new publishers. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedPublishers | ||
Description |
Registers for notification of updated publishers.
| ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedPublisher | ||
Description |
Registers for notification of an updated publisher.
| ||
Parameters | osid.id.Id | publisherId | the Id of the Publisher to monitor |
Errors | NULL_ARGUMENT | publisherId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedPublishers | ||
Description |
Registers for notification of deleted publishers.
| ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedPublisher | ||
Description |
Registers for notification of a deleted publisher.
| ||
Parameters | osid.id.Id | publisherId | the Id of the Publisher to monitor |
Errors | NULL_ARGUMENT | publisherId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedPublisherHierarchy | ||
Description |
Registers for notification of an updated publisher
hierarchy structure. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedPublisherHierarchyForAncestors | ||
Description |
Registers for notification of an updated publisher
hierarchy structure. | ||
Parameters | osid.id.Id | publisherId | the Id of the Publisher node to monitor |
Errors | NULL_ARGUMENT | publisherId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedPublisherHierarchyForDescendants | ||
Description |
Registers for notification of an updated publisher
hierarchy structure. | ||
Parameters | osid.id.Id | publisherId | the Id of the Publisher node to monitor |
Errors | NULL_ARGUMENT | publisherId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |