OSID Logo
OSID Specifications
subscription package
Version 3.0.0
Release Candidate Preview
Interfaceosid.subscription.SubscriptionNotificationSession
Implementsosid.OsidSession
Description

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

MethodgetPublisherId
Description

Gets the Publisher Id associated with this session.

Returnosid.id.Idthe Publisher Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetPublisher
Description

Gets the Publisher associated with this session.

Returnosid.subscription.Publisherthe publisher
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanRegisterForSubscriptionNotifications
Description

Tests if this user can register for Subscription 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.
MethoduseFederatedPublisherView
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.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedPublisherView
Description

Isolates the view for methods in this session. An isolated view restricts retrievals to this publisher only.

CompliancemandatoryThis method is must be implemented.
MethodreliableSubscriptionNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodunreliableSubscriptionNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodacknowledgeSubscriptionNotification
Description

Acknowledge a subscription notification.

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

Register for notifications of new subscriptions. SubscriptionReceiver.newSubscriptions() is invoked when a new Subscription is created.

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

Register for notifications of new subscriptions of the given genus type. SubscriptionReceiver.newSubscriptions() is invoked when a new Subscription is created.

Parametersosid.type.TypesubscriptionGenusTypea subscription genus type
ErrorsNULL_ARGUMENT subscriptionGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewSubscriptionsForSubscriber
Description

Register for notifications of new subscriptions for the given resource Id. SubscriptionReceiver.newSubscriptions() is invoked when a new Subscription is created.

Parametersosid.id.IdresourceIdthe Id of the reference to monitor
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewSubscriptionsForDispatch
Description

Register for notifications of new subscriptions for the given reference Id. SubscriptionReceiver.newSubscriptions() is invoked when a new Subscription is created.

Parametersosid.id.IddispatchIdthe Id of the dispatch to monitor
ErrorsNULL_ARGUMENT dispatchId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedSubscriptions
Description

Registers for notification of updated subscriptions. SubscriptionReceiver.changedSubscriptions() is invoked when a subscription is changed.

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

Registers for notification of updated subscriptions of the given genus type. SubscriptionReceiver.changedSubscriptions() is invoked when a subscription is changed.

Parametersosid.type.TypesubscriptionGenusTypea subscription genus type
ErrorsNULL_ARGUMENT subscriptionGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedSubscriptionsForSubscriber
Description

Register for notifications of changed subscriptions for the given resource Id. SubscriptionReceiver.changedSubscriptions() is invoked when a Subscription for the resource is changed.

Parametersosid.id.IdresourceIdthe Id of the resource to monitor
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedSubscriptionsForDispatch
Description

Register for notifications of changed subscriptions for the given dispatch Id. SubscriptionReceiver.changedSubscription() is invoked when a Subscription for the dispatch is changed.

Parametersosid.id.IddispatchIdthe Id of the dispatch to monitor
ErrorsNULL_ARGUMENT dispatchId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedSubscription
Description

Registers for notification of an updated subscription. SubscriptionReceiver.changedSubscriptions() is invoked when the specified subscription is changed.

Parametersosid.id.IdsubscriptionIdthe Id of the Subscription to monitor
ErrorsNULL_ARGUMENT subscriptionId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedSubscriptions
Description

Registers for notification of deleted subscriptions. SubscriptionReceiver.deletedSubscriptions() is invoked when a subscription is deleted.

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

Registers for notification of deleted subscriptions of the given genus type. SubscriptionReceiver.deletedSubscriptions() is invoked when a subscription is deleted.

Parametersosid.type.TypesubscriptionGenusTypea subscription genus type
ErrorsNULL_ARGUMENT subscriptionGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedSubscriptionsForSubscriber
Description

Register for notifications of changed subscriptions for the given subscriber Id. SubscriptionReceiver.deletedSubscriptions() is invoked when a Subscription for the resource is deleted.

Parametersosid.id.IdresourceIdthe Id of the resource to monitor
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedSubscriptionsForDispatch
Description

Register for notifications of changed subscriptions for the given dispatch Id. SubscriptionReceiver.deletedSubscriptions() is invoked when a Subscription for the dispatch is deleted.

Parametersosid.id.IddispatchIdthe Id of the dispatch to monitor
ErrorsNULL_ARGUMENT dispatchId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedSubscription
Description

Registers for notification of a deleted subscription. SubscriptionReceiver.deletedSubscriptions() is invoked when the specified subscription is deleted.

Parametersosid.id.IdsubscriptionIdthe Id of the Subscription to monitor
ErrorsNULL_ARGUMENT subscriptionId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.