OSID - osid.tracking.rules.QueueEnablerNotificationSession Service Interface Definition

Interface	osid.tracking.rules.QueueEnablerNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.tracking.rules.TrackingRulesManager`
Used By	`osid.tracking.rules.TrackingRulesProxyManager`
Description	This session defines methods to receive notifications on adds/changes to `QueueEnablers` in this `FrontOffice` . This also includes existing queue enablers that may appear or disappear due to changes in the `FrontOffice hi` erarchy, 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 `QueueEnablerLookupSession` .
Method	getFrontOfficeId
Description	Gets the `FrontOffice` `Id` associated with this session.
Return	`osid.id.Id`		the `FrontOffice Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getFrontOffice
Description	Gets the `FrontOffice` associated with this session.
Return	`osid.tracking.FrontOffice`		the front office
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canRegisterForQueueEnablerNotifications
Description	Tests if this user can register for `QueueEnabler` 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	useFederatedFrontOfficeView
Description	Federates the view for methods in this session. A federated view will include queue enablers in front offices which are children of this front office in the front office hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedFrontOfficeView
Description	Isolates the view for methods in this session. An isolated view restricts notifications to this front office only.
Compliance	`mandatory`		This method is must be implemented.
Method	reliableQueueEnablerNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeQueueEnablerNotification()` .
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableQueueEnablerNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeQueueEnablerNotification
Description	Acknowledge a queue 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	registerForNewQueueEnablers
Description	Register for notifications of new queue enablers. `QueueEnablerReceiver.newQueueEnablers:()` is invoked when a new `QueueEnabler` appears in this front office.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedQueueEnablers
Description	Register for notifications of updated queue enablers. `QueueEnablerReceiver.changedQueueEnablers()` is invoked when a `QueueEnabler` in this front office is changed.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForChangedQueueEnabler
Description	Register for notifications of an updated queue enabler. `QueueEnablerReceiver.changedQueueEnablers()` is invoked when the specified `QueueEnabler` in this front office is changed.
Parameters	`osid.id.Id`	`queueEnablerId`	the `Id` of the `QueueEnabler` to monitor
Errors	NULL_ARGUMENT		`queueEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedQueueEnablers
Description	Registers for notification of deleted queue enablers. `QueueEnablerReceiver.deletedQueueEnablers()` is invoked when a queue enabler is deleted or removed from this front office.
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedQueueEnabler
Description	Registers for notification of a deleted queue enabler. `QueueEnablerReceiver.deletedQueueEnabler()` is invoked when the specified queue enabler is deleted or removed from this front office.
Parameters	`osid.id.Id`	`queueEnablerId`	the `Id` of the `QueueEnabler` to monitor
Errors	NULL_ARGUMENT		`queueEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.