Interface | osid.subscription.SubscriptionNotificationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods to receive notifications on
adds/changes to | ||
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 | canRegisterForSubscriptionNotifications | ||
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 entries 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 | reliableSubscriptionNotifications | ||
Description |
Reliable notifications are desired. In reliable mode,
notifications are to be acknowledged using | ||
Compliance | mandatory | This method is must be implemented. | |
Method | unreliableSubscriptionNotifications | ||
Description |
Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | acknowledgeSubscriptionNotification | ||
Description |
Acknowledge a subscription 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 | registerForNewSubscriptions | ||
Description |
Register for notifications of new subscriptions. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewSubscriptionsByGenusType | ||
Description |
Register for notifications of new subscriptions of the
given genus type. | ||
Parameters | osid.type.Type | subscriptionGenusType | a subscription genus type |
Errors | NULL_ARGUMENT | subscriptionGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewSubscriptionsForSubscriber | ||
Description |
Register for notifications of new subscriptions for the
given resource | ||
Parameters | osid.id.Id | resourceId | the Id of the reference to monitor |
Errors | NULL_ARGUMENT | resourceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewSubscriptionsForDispatch | ||
Description |
Register for notifications of new subscriptions for the
given reference | ||
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 | registerForChangedSubscriptions | ||
Description |
Registers for notification of updated subscriptions.
| ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedSubscriptionsByGenusType | ||
Description |
Registers for notification of updated subscriptions of
the given genus type. | ||
Parameters | osid.type.Type | subscriptionGenusType | a subscription genus type |
Errors | NULL_ARGUMENT | subscriptionGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedSubscriptionsForSubscriber | ||
Description |
Register for notifications of changed subscriptions for
the given resource | ||
Parameters | osid.id.Id | resourceId | the Id of the resource to monitor |
Errors | NULL_ARGUMENT | resourceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedSubscriptionsForDispatch | ||
Description |
Register for notifications of changed subscriptions for
the given 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 | registerForChangedSubscription | ||
Description |
Registers for notification of an updated subscription.
| ||
Parameters | osid.id.Id | subscriptionId | the Id of the Subscription to monitor |
Errors | NULL_ARGUMENT | subscriptionId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedSubscriptions | ||
Description |
Registers for notification of deleted subscriptions.
| ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedSubscriptionsByGenusType | ||
Description |
Registers for notification of deleted subscriptions of
the given genus type. | ||
Parameters | osid.type.Type | subscriptionGenusType | a subscription genus type |
Errors | NULL_ARGUMENT | subscriptionGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedSubscriptionsForSubscriber | ||
Description |
Register for notifications of changed subscriptions for
the given subscriber | ||
Parameters | osid.id.Id | resourceId | the Id of the resource to monitor |
Errors | NULL_ARGUMENT | resourceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedSubscriptionsForDispatch | ||
Description |
Register for notifications of changed subscriptions for
the given 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 | registerForDeletedSubscription | ||
Description |
Registers for notification of a deleted subscription.
| ||
Parameters | osid.id.Id | subscriptionId | the Id of the Subscription to monitor |
Errors | NULL_ARGUMENT | subscriptionId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |