Interface | osid.provisioning.PoolNotificationSession | ||
---|---|---|---|
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 | canRegisterForPoolNotifications | ||
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 pools 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 | registerForNewPools | ||
Description |
Register for notifications of new pools. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForNewPoolsForBroker | ||
Description |
Register for notifications of new pools for the given
broker | ||
Parameters | osid.id.Id | brokerId | the Id of the broker to monitor |
Errors | NULL_ARGUMENT | brokerId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedPools | ||
Description |
Registers for notification of updated pools. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedPoolsForBroker | ||
Description |
Register for notifications of updated pools for the
given broker | ||
Parameters | osid.id.Id | brokerId | the Id of the broker to monitor |
Errors | NULL_ARGUMENT | brokerId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForChangedPool | ||
Description |
Registers for notification of an updated pool. | ||
Parameters | osid.id.Id | poolId | the Id of the Pool to monitor |
Errors | NULL_ARGUMENT | poolId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedPools | ||
Description |
Registers for notification of deleted pools. | ||
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedPoolsForBroker | ||
Description |
Register for notifications of deleted pools for the
given broker | ||
Parameters | osid.id.Id | brokerId | the Id of the broker to monitor |
Errors | NULL_ARGUMENT | brokerId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | registerForDeletedPool | ||
Description |
Registers for notification of a deleted pool. | ||
Parameters | osid.id.Id | poolId | the Id of the Pool to monitor |
Errors | NULL_ARGUMENT | poolId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |