OSID Logo
OSID Specifications
tracking rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.tracking.rules.QueueConstrainerEnablerNotificationSession
Implementsosid.OsidSession
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.

MethodgetFrontOfficeId
Description

Gets the FrontOffice Id associated with this session.

Returnosid.id.Idthe FrontOffice Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetFrontOffice
Description

Gets the FrontOffice associated with this session.

Returnosid.tracking.FrontOfficethe office
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanRegisterForQueueConstrainerEnablerNotifications
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.

Returnboolean false if notification methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseFederatedFrontOfficeView
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.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedFrontOfficeView
Description

Isolates the view for methods in this session. An isolated view restricts notifications to this front office only.

CompliancemandatoryThis method is must be implemented.
MethodregisterForNewQueueConstrainerEnablers
Description

Register for notifications of new queue constrainer enablers. QueueConstrainerEnablerReceiver.newQueueConstrainerEnablers() is invoked when a new QueueConstrainerEnabler appears in this front office.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedQueueConstrainerEnablers
Description

Registers for notification of updated front office enabelrs. QueueConstrainerEnablerReceiver.changedQueueConstrainerEnablers() is invoked when a queue constrainer enabler in this front office is changed.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedQueueConstrainerEnabler
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.

Parametersosid.id.IdqueueConstrainerEnablerIdthe Id of the QueueConstrainerEnabler to monitor
ErrorsNOT_FOUNDa queue constrainer enabler was not found in this queue matchmaker identified by the given Id
NULL_ARGUMENT queueConstrainerEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedQueueConstrainerEnablers
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.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedQueueConstrainerEnabler
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.

Parametersosid.id.IdqueueConstrainerEnablerIdthe Id of the QueueConstrainerEnabler to monitor
ErrorsNOT_FOUNDa queue constrainer enabler was not found in this queue matchmaker identified by the given Id
NULL_ARGUMENT queueConstrainerEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.