Interface | osid.subscription.DispatchNotificationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods to receive notifications on
adds/changes to Notifications are triggered with changes to the | ||
Method | getPublisherId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Publisher Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getPublisher | ||
Description |
Gets the | ||
Return | osid.subscription.Publisher | the publisher | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canRegisterForDispatchNotifications | ||
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 | useFederatedPublisherView | ||
Description |
Federates the view for methods in this session. A federated view will include dispatches in publishers which are children of this publisher in the publisher hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedPublisherView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts retrievals to this publisher only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | reliableDispatchNotifications | ||
Description |
Reliable notifications are desired. In reliable mode,
notifications are to be acknowledged using | ||
Compliance | mandatory | This method is must be implemented. | |
Method | unreliableDispatchNotifications | ||
Description |
Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | acknowledgeDispatchNotification | ||
Description |
Acknowledge a dispatch 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 | registerForNewDispatches | ||
Description |
Register for notifications of new dispatches. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedDispatches | ||
Description |
Registers for notification of updated dispatches.
| ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedDispatch | ||
Description |
Registers for notification of an updated dispatch.
| ||
Parameters | osid.id.Id | dispatchId | the Id of the Dispatch to monitor |
Errors | NULL_ARGUMENT | dispatchId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedDispatches | ||
Description |
Registers for notification of deleted dispatches.
| ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedDispatch | ||
Description |
Registers for notification of a deleted dispatch.
| ||
Parameters | osid.id.Id | dispatchId | the Id of the Dispatch to monitor |
Errors | NULL_ARGUMENT | dispatchId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |