OSID - osid.tracking.QueueNotificationSession Service Interface Definition

Interface	osid.tracking.QueueNotificationSession
Implements	`osid.OsidSession`
Used By	`osid.tracking.TrackingManager`
Used By	`osid.tracking.TrackingProxyManager`
Description	This session defines methods to receive notifications on adds/changes to `Queue` objects in this `FrontOffice` . This also includes existing queues that may appear or disappear due to changes in the `FrontOffice` 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 `QueueLookupSession` .
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	canRegisterForQueueNotifications
Description	Tests if this user can register for `Queue` 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 queues 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	reliableQueueNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeQueueNotification()` .
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableQueueNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeQueueNotification
Description	Acknowledge a queue 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	registerForNewQueues
Description	Register for notifications of new queues. `QueueReceiver.newQueues()` is invoked when a new `Queue` 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	registerForChangedQueues
Description	Registers for notification of updated queues. `QueueReceiver.changedQueues()` is invoked when a queue 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	registerForChangedQueue
Description	Registers for notification of an updated queue. `QueueReceiver.changedQueues()` is invoked when the specified queue in this front office is changed.
Parameters	`osid.id.Id`	`queueId`	the `Id` of the `Queue` to monitor
Errors	NULL_ARGUMENT		`queueId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedQueues
Description	Registers for notification of deleted queues. `QueueReceiver.deletedQueues()` is invoked when a queue 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	registerForDeletedQueue
Description	Registers for notification of a deleted queue. `QueueReceiver.deletedQueues()` is invoked when the specified queue is deleted or removed from this front office.
Parameters	`osid.id.Id`	`queueId`	the `Id` of the `Queue` to monitor
Errors	NULL_ARGUMENT		`queueId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.