OSID Logo
OSID Specifications
provisioning rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.provisioning.rules.QueueProcessorNotificationSession
Implementsosid.OsidSession
Description

This session defines methods to receive notifications on adds/changes to QueueProcessor objects in this Distributor. This also includes existing QueueProcessors that may appear or disappear due to changes in the Distributor 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 QueueProcessorLookupSession.

MethodgetDistributorId
Description

Gets the Distributor Id associated with this session.

Returnosid.id.Idthe Distributor Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetDistributor
Description

Gets the Distributor associated with this session.

Returnosid.provisioning.Distributorthe distributor
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanRegisterForQueueProcessorNotifications
Description

Tests if this user can register for QueueProcessor 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.
MethoduseFederatedDistributorView
Description

Federates the view for methods in this session. A federated view will include in distributors which are children of this distributor in the distributor hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedDistributorView
Description

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

CompliancemandatoryThis method is must be implemented.
MethodregisterForNewQueueProcessors
Description

Register for notifications of new queue processors. QueueProcessorReceiver.newQueueProcessors() is invoked when a new QueueProcessor appears in this distributor.

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

Registers for notification of updated distributors. QueueProcessorReceiver.changedQueueProcessors() is invoked when a queue processor in this distributor is changed.

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

Registers for notification of an updated queue processor. ProvisionableReceiver.changedQueueProcessors() is invoked when the specified queue processor in this distributor is changed.

Parametersosid.id.IdqueueProcessorIdthe Id of the QueueProcessor to monitor
ErrorsNULL_ARGUMENT queueProcessorId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedQueueProcessors
Description

Registers for notification of deleted queue processors. QueueProcessorReceiver.deletedQueueProcessors() is invoked when a queue processor is deleted or removed from this distributor.

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

Registers for notification of a deleted queue processor. QueueProcessorReceiver.deletedQueueProcessors() is invoked when the specified queue processor is deleted or removed from this distributor.

Parametersosid.id.IdqueueProcessorIdthe Id of the QueueProcessor to monitor
ErrorsNULL_ARGUMENT queueProcessorId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.