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

Interface	osid.tracking.rules.QueueConstrainerEnablerNotificationSession
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 `QueueConstrainerEnabler` objects in this `FrontFront Office` . This also includes existing `QueueConstrainerEnablers` 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 `QueueConstrainerEnablerLookupSession` .
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 office
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canRegisterForQueueConstrainerEnablerNotifications
Description	Tests if this user can register for `QueueConstrainerEnabler` 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 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	reliableQueueConstrainerEnablerNotifications
Description	Reliable notifications are desired. In reliable mode, notifications are to be acknowledged using `acknowledgeQueueConstrainerEnablerNotification()` .
Compliance	`mandatory`		This method is must be implemented.
Method	unreliableQueueConstrainerEnablerNotifications
Description	Unreliable notifications are desired. In unreliable mode, notifications do not need to be acknowledged.
Compliance	`mandatory`		This method is must be implemented.
Method	acknowledgeQueueConstrainerEnablerNotification
Description	Acknowledge a queue constrainer 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	registerForNewQueueConstrainerEnablers
Description	Register for notifications of new queue constrainer enablers. `QueueConstrainerEnablerReceiver.newQueueConstrainerEnablers()` is invoked when a new `QueueConstrainerEnabler` 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	registerForChangedQueueConstrainerEnablers
Description	Registers for notification of updated front office enabelrs. `QueueConstrainerEnablerReceiver.changedQueueConstrainerEnablers()` is invoked when a queue constrainer enabler 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	registerForChangedQueueConstrainerEnabler
Description	Registers for notification of an updated queue constrainer enabler. `ProvisionableReceiver.changedQueueConstrainerEnablers()` is invoked when the specified queue constrainer enabler in this front office is changed.
Parameters	`osid.id.Id`	`queueConstrainerEnablerId`	the `Id` of the `QueueConstrainerEnabler` to monitor
Errors	NOT_FOUND		a queue constrainer enabler was not found in this queue matchmaker identified by the given `Id`
	NULL_ARGUMENT		`queueConstrainerEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	registerForDeletedQueueConstrainerEnablers
Description	Registers for notification of deleted queue constrainer enablers. `QueueConstrainerEnablerReceiver.deletedQueueConstrainerEnablers()` is invoked when a queue constrainer 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	registerForDeletedQueueConstrainerEnabler
Description	Registers for notification of a deleted queue constrainer enabler. `QueueConstrainerEnablerReceiver.deletedQueueConstrainerEnablers()` is invoked when the specified queue constrainer enabler is deleted or removed from this front office.
Parameters	`osid.id.Id`	`queueConstrainerEnablerId`	the `Id` of the `QueueConstrainerEnabler` to monitor
Errors	NOT_FOUND		a queue constrainer enabler was not found in this queue matchmaker identified by the given `Id`
	NULL_ARGUMENT		`queueConstrainerEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.