Interface | osid.provisioning.rules.PoolProcessorSmartDistributorSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session manages queries and sequencing to create
"smart" dynamic distributors. A This | ||
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 | canManageSmartDistributors | ||
Description |
Tests if this user can manage smart distributors. A
return of true does not guarantee successful
authorization. A return of false indicates that it is
known methods in this session will result in a | ||
Return | boolean | false if smart distributor management is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getPoolProcessorQuery | ||
Description |
Gets a pool processor query. | ||
Return | osid.provisioning.rules.PoolProcessorQuery | the pool processor query | |
Compliance | mandatory | This method must be implemented. | |
Method | getPoolProcessorSearchOrder | ||
Description |
Gets a pool processor search order. | ||
Return | osid.provisioning.rules.PoolProcessorSearchOrder | the pool processor search order | |
Compliance | mandatory | This method must be implemented. | |
Method | applyPoolProcessorQuery | ||
Description |
Applies a pool processor query to this distributor. | ||
Parameters | osid.provisioning.rules.PoolProcessorQuery | poolProcessorQuery | the pool processor query |
Errors | NULL_ARGUMENT | poolProcessorQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | poolProcessorQuery not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | inspectPoolProcessorQuery | ||
Description |
Gets a pool processor query inspector for this distributor. | ||
Return | osid.provisioning.rules.PoolProcessorQueryInspector | the pool processor query inspector | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | applyPoolProcessorSequencing | ||
Description |
Applies a pool processor search order to this distributor. | ||
Parameters | osid.provisioning.rules.PoolProcessorSearchOrder | poolProcessorSearchOrder | the pool processor search order |
Errors | NULL_ARGUMENT | poolProcessorSearchOrder is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
UNSUPPORTED | poolProcessorSearchOrder not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getPoolProcessorQueryFromInspector | ||
Description |
Gets a pool processor query from an inspector. | ||
Parameters | osid.provisioning.rules.PoolProcessorQueryInspector | poolProcessorQueryInspector | a pool processor query inspector |
Return | osid.provisioning.rules.PoolProcessorQuery | the pool processor query | |
Errors | NULL_ARGUMENT | poolProcessorQueryInspector is null | |
UNSUPPORTED | poolProcessorQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |