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

This session defines methods to receive notifications on adds/changes to SubscriptionEnabler objects in this Subscription. This also includes existing SubscriptionEnablers that may appear or disappear due to changes in the Subscription hierarchy, 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.

The two views defined in this session correspond to the views in the SubscriptionEnablerLookupSession.

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.
MethodcanRegisterForSubscriptionEnablerNotifications
Description

Tests if this user can register for SubscriptionEnabler 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 subscription enablers 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 lookups to this publisher only.

CompliancemandatoryThis method is must be implemented.
MethodreliableSubscriptionEnablerNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodunreliableSubscriptionEnablerNotifications
Description

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

CompliancemandatoryThis method is must be implemented.
MethodacknowledgeSubscriptionEnablerNotification
Description

Acknowledge a subscription enabler notification.

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

Register for notifications of new subscription enablers. SubscriptionEnablerReceiver.newSubscriptionEnablers() is invoked when a new SubscriptionEnabler appears in this publisher.

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

Registers for notification of updated subscription enabelrs. SubscriptionEnablerReceiver.changedSubscriptionEnablers() is invoked when a subscription enabler in this publisher is changed.

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

Registers for notification of an updated subscription enabler. ProvisionableReceiver.changedSubscriptionEnablers() is invoked when the specified subscription enabler in this publisher is changed.

Parametersosid.id.IdsubscriptionEnablerIdthe Id of the SubscriptionEnabler to monitor
ErrorsNULL_ARGUMENT subscriptionEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedSubscriptionEnablers
Description

Registers for notification of deleted subscription enablers. SubscriptionEnablerReceiver.deletedSubscriptionEnablers() is invoked when a subscription enabler is deleted or removed from this publisher.

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

Registers for notification of a deleted subscription enabler. SubscriptionEnablerReceiver.deletedSubscriptionEnablers() is invoked when the specified subscription enabler is deleted or removed from this publisher.

Parametersosid.id.IdsubscriptionEnablerIdthe Id of the SubscriptionEnabler to monitor
ErrorsNULL_ARGUMENT subscriptionEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.