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

Interface	osid.subscription.rules.DispatchProcessorNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.subscription.rules.SubscriptionRulesManager`
Used By	`osid.subscription.rules.SubscriptionRulesProxyManager`
Description	This session defines methods to receive notifications on adds/changes to `DispatchProcessors` in this `Publisher` . This also includes existing dispatch processors that may appear or disappear due to changes in the `Publisher hier` archy, 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 `DispatchProcessorLookupSession` .
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	canRegisterForDispatchProcessorNotifications
Description	Tests if this user can register for `DispatchProcessor` 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 dispatch processors 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 notifications to this publisher only.
Compliance	`mandatory`		This method is must be implemented.
Method	reliableDispatchProcessorNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeDispatchProcessorNotification()` .
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableDispatchProcessorNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeDispatchProcessorNotification
Description	Acknowledge a dispatch processor 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	registerForNewDispatchProcessors
Description	Register for notifications of new dispatch processors. `DispatchProcessorReceiver.newDispatchProcessors()` is invoked when a new `DispatchProcessor` appears in this publisher.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedDispatchProcessors
Description	Register for notifications of updated dispatch processors. `DispatchProcessorReceiver.changedDispatchProcessors()` is invoked when a `DispatchProcessor` 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	registerForChangedDispatchProcessor
Description	Register for notifications of an updated dispatch processor. `DispatchProcessorReceiver.changedDispatchProcessors()` is invoked when the specified `DispatchProcessor` in this publisher is changed.
Parameters	`osid.id.Id`	`dispatchProcessorId`	the `Id` of the `DispatchProcessor` to monitor
Errors	NULL_ARGUMENT		`dispatchProcessorId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedDispatchProcessors
Description	Registers for notification of deleted dispatch processors. `DispatchProcessorReceiver.deletedDispatchProcessors()` is invoked when a dispatch processor 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	registerForDeletedDispatchProcessor
Description	Registers for notification of a deleted dispatch processor. `DispatchProcessorReceiver.deletedDispatchProcessor()` is invoked when the specified dispatch processor is deleted or removed from this publisher.
Parameters	`osid.id.Id`	`dispatchProcessorId`	the `Id` of the `DispatchProcessor` to monitor
Errors	NULL_ARGUMENT		`dispatchProcessorId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.