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

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

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.
MethodcanRegisterForRequestNotifications
Description

Tests if this user can register for Request 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 requests 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.
MethodregisterForNewRequests
Description

Register for notifications of new requests. RequestReceiver.newRequests() is invoked when a new Request appears in this distributor.

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

Register for notifications of new requests for the given resource Id. RequestReceiver.newRequests() is invoked when a new Request is created.

Parametersosid.id.IdresourceIdthe Id of the resource to monitor
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForNewRequestsForQueue
Description

Register for notifications of new requests for the given queue Id. RequestReceiver.newRequests() is invoked when a new Request is created.

Parametersosid.id.IdqueueIdthe Id of the queue to monitor
ErrorsNULL_ARGUMENT queueId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedRequests
Description

Registers for notification of updated requests. RequestReceiver.changedRequests() is invoked when a request in this distributor is changed.

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

Register for notifications of updated requests for the given resource Id. RequestReceiver.changedRequests() is invoked when a Request in this distributor is changed.

Parametersosid.id.IdresourceIdthe Id of the resource to monitor
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedRequestsForQueue
Description

Register for notifications of updated requests for the given queue Id. RequestReceiver.changedRequests() is invoked when a Request in this distributor is changed.

Parametersosid.id.IdqueueIdthe Id of the queue to monitor
ErrorsNULL_ARGUMENT queueId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForChangedRequest
Description

Registers for notification of an updated request. RequestReceiver.changedRequests() is invoked when the specified request in this distributor is changed.

Parametersosid.id.IdrequestIdthe Id of the Request to monitor
ErrorsNULL_ARGUMENT requestId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedRequests
Description

Registers for notification of deleted requests. RequestReceiver.deletedRequests() is invoked when a request is deleted or removed from this distributor.

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

Register for notifications of deleted requests for the given resource Id. RequestReceiver.deletedRequests() is invoked when a Request is deleted or removed from this distributor.

Parametersosid.id.IdresourceIdthe Id of the resource to monitor
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedRequestsForQueue
Description

Register for notifications of deleted requests for the given queue Id. RequestReceiver.deletedRequests() is invoked when a Request is deleted or removed from this distributor.

Parametersosid.id.IdqueueIdthe Id of the queue to monitor
ErrorsNULL_ARGUMENT queueId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodregisterForDeletedRequest
Description

Registers for notification of a deleted request. RequestReceiver.deletedRequests() is invoked when the specified request is deleted or removed from this distributor.

Parametersosid.id.IdrequestIdthe Id of the Request to monitor
ErrorsNULL_ARGUMENT requestId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.