Interface | osid.provisioning.RequestNotificationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods to receive notifications on
adds/changes to The two views defined in this session correspond to the
views in the | ||
Method | getDistributorId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Distributor Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getDistributor | ||
Description |
Gets the | ||
Return | osid.provisioning.Distributor | the distributor | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canRegisterForRequestNotifications | ||
Description |
Tests if this user can register for | ||
Return | boolean | false if notification methods are not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useFederatedDistributorView | ||
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. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedDistributorView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts notifications to this distributor only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | registerForNewRequests | ||
Description |
Register for notifications of new requests. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewRequestsForResource | ||
Description |
Register for notifications of new requests for the
given resource | ||
Parameters | osid.id.Id | resourceId | the Id of the resource to monitor |
Errors | NULL_ARGUMENT | resourceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewRequestsForQueue | ||
Description |
Register for notifications of new requests for the
given queue | ||
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 | registerForChangedRequests | ||
Description |
Registers for notification of updated requests. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedRequestsForResource | ||
Description |
Register for notifications of updated requests for the
given resource | ||
Parameters | osid.id.Id | resourceId | the Id of the resource to monitor |
Errors | NULL_ARGUMENT | resourceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedRequestsForQueue | ||
Description |
Register for notifications of updated requests for the
given queue | ||
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 | registerForChangedRequest | ||
Description |
Registers for notification of an updated request.
| ||
Parameters | osid.id.Id | requestId | the Id of the Request to monitor |
Errors | NULL_ARGUMENT | requestId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedRequests | ||
Description |
Registers for notification of deleted requests. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedRequestsForResource | ||
Description |
Register for notifications of deleted requests for the
given resource | ||
Parameters | osid.id.Id | resourceId | the Id of the resource to monitor |
Errors | NULL_ARGUMENT | resourceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedRequestsForQueue | ||
Description |
Register for notifications of deleted requests for the
given queue | ||
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 | registerForDeletedRequest | ||
Description |
Registers for notification of a deleted request. | ||
Parameters | osid.id.Id | requestId | the Id of the Request to monitor |
Errors | NULL_ARGUMENT | requestId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |