OSID - osid.subscription.rules.SubscriptionEnablerNotificationSession Service Interface Definition

Interface	osid.subscription.rules.SubscriptionEnablerNotificationSession
Implements	`osid.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.`
Method	getPublisherId
Description	Gets the `Publisher` `Id` associated with this session.
Return	`osid.id.Id`		the `Publisher Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getPublisher
Description	Gets the `Publisher` associated with this session.
Return	`osid.subscription.Publisher`		the publisher
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canRegisterForSubscriptionEnablerNotifications
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.
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 subscription enablers 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 lookups to this publisher only.
Compliance	`mandatory`		This method is must be implemented.
Method	reliableSubscriptionEnablerNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeSubscriptionEnablerNotification()` .
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableSubscriptionEnablerNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeSubscriptionEnablerNotification
Description	Acknowledge a subscription enabler notification.
Parameters	`osid.id.Id`	`notificationId`	the `Id` of the notification
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewSubscriptionEnablers
Description	Register for notifications of new subscription enablers. `SubscriptionEnablerReceiver.newSubscriptionEnablers()` is invoked when a new `SubscriptionEnabler` appears in this publisher.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedSubscriptionEnablers
Description	Registers for notification of updated subscription enabelrs. `SubscriptionEnablerReceiver.changedSubscriptionEnablers()` is invoked when a subscription enabler in this publisher is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedSubscriptionEnabler
Description	Registers for notification of an updated subscription enabler. `ProvisionableReceiver.changedSubscriptionEnablers()` is invoked when the specified subscription enabler in this publisher is changed.
Parameters	`osid.id.Id`	`subscriptionEnablerId`	the `Id` of the `SubscriptionEnabler` to monitor
Errors	NULL_ARGUMENT		`subscriptionEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedSubscriptionEnablers
Description	Registers for notification of deleted subscription enablers. `SubscriptionEnablerReceiver.deletedSubscriptionEnablers()` is invoked when a subscription enabler is deleted or removed from this publisher.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedSubscriptionEnabler
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.
Parameters	`osid.id.Id`	`subscriptionEnablerId`	the `Id` of the `SubscriptionEnabler` to monitor
Errors	NULL_ARGUMENT		`subscriptionEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.