OSID - osid.subscription.SubscriptionNotificationSession Service Interface Definition

Interface	osid.subscription.SubscriptionNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.subscription.SubscriptionManager`
Used By	`osid.subscription.SubscriptionProxyManager`
Description	This session defines methods to receive notifications on adds/changes to `Subscriptions`. 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.
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	canRegisterForSubscriptionNotifications
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.
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 `acknowledgeSubscriptionNotification()`.
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
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForNewSubscriptions
Description	Register for notifications of new subscriptions. `SubscriptionReceiver.newSubscriptions()` is invoked when a new `Subscription` is created.
Errors	OPERATION_FAILED		unable to complete request
Errors	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. `SubscriptionReceiver.newSubscriptions()` is invoked when a new `Subscription` is created.
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 `Id`. `SubscriptionReceiver.newSubscriptions()` is invoked when a new `Subscription` is created.
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 `Id`. `SubscriptionReceiver.newSubscriptions()` is invoked when a new `Subscription` is created.
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. `SubscriptionReceiver.changedSubscriptions()` is invoked when a subscription is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	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. `SubscriptionReceiver.changedSubscriptions()` is invoked when a subscription is changed.
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 `Id`. `SubscriptionReceiver.changedSubscriptions()` is invoked when a `Subscription` for the resource is changed.
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 `Id`. `SubscriptionReceiver.changedSubscription()` is invoked when a `Subscription` for the dispatch is changed.
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. `SubscriptionReceiver.changedSubscriptions()` is invoked when the specified subscription is changed.
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. `SubscriptionReceiver.deletedSubscriptions()` is invoked when a subscription is deleted.
Errors	OPERATION_FAILED		unable to complete request
Errors	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. `SubscriptionReceiver.deletedSubscriptions()` is invoked when a subscription is deleted.
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 `Id`. `SubscriptionReceiver.deletedSubscriptions()` is invoked when a `Subscription` for the resource is deleted.
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 `Id`. `SubscriptionReceiver.deletedSubscriptions()` is invoked when a `Subscription` for the dispatch is deleted.
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. `SubscriptionReceiver.deletedSubscriptions()` is invoked when the specified subscription is deleted.
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.