Interface | osid.provisioning.rules.PoolProcessorRuleApplicationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to apply | ||
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 | canAssignPoolProcessors | ||
Description |
Tests if this user can alter pool processor/pool
mappings. A return of true does not guarantee successful
authorization. A return of false indicates that it is
known mapping methods in this session will result in a
| ||
Return | boolean | false if mapping is not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | assignPoolProcessorToPool | ||
Description |
Adds a existing | ||
Parameters | osid.id.Id | poolProcessorId | the Id of the PoolProcessor |
osid.id.Id | poolId | the Id of the Pool | |
Errors | ALREADY_EXISTS | poolProcessorId is already applied to poolId | |
NOT_FOUND | poolProcessorId or poolId not found | ||
NULL_ARGUMENT | poolProcessorId or poolId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | unassignPoolProcessorFromPool | ||
Description |
Removes a | ||
Parameters | osid.id.Id | poolProcessorId | the Id of the PoolProcessor |
osid.id.Id | poolId | the Id of the Pool | |
Errors | NOT_FOUND | poolProcessorId or poolId not found or
poolProcessorId not applied to poolId | |
NULL_ARGUMENT | poolProcessorId or poolId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canSequencePoolProcessors | ||
Description |
Tests if this user can order | ||
Return | boolean | false if PoolProcessor ordering is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | movePoolProcessorAhead | ||
Description |
Reorders pool processors for a pool by moving the specified pool processor in front of a reference pool processor. | ||
Parameters | osid.id.Id | poolProcessorId | the Id of a PoolProcessor |
osid.id.Id | poolId | the Id of a Pool | |
osid.id.Id | referenceId | the reference pool processor Id | |
Errors | NOT_FOUND | poolProcessorId, poolId, or referenceId not
found or, poolProcessorId or referenceId not
related to poolId | |
NULL_ARGUMENT | poolProcessorId, poolId, or referenceId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | movePoolProcessorBehind | ||
Description |
Reorders pool processors for a pool by moving the specified pool processor behind a reference pool processor. | ||
Parameters | osid.id.Id | poolProcessorId | the Id of a PoolProcessor |
osid.id.Id | poolId | the Id of a Pool | |
osid.id.Id | referenceId | the reference pool processor Id | |
Errors | NOT_FOUND | poolProcessorId, poolId, or referenceId not
found or, poolProcessorId or referenceId not
related to poolId | |
NULL_ARGUMENT | poolProcessorId, poolId, or referenceId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | orderPoolProcessors | ||
Description |
Reorders a set of pool processors for a pool. | ||
Parameters | osid.id.Id[] | poolProcessorIds | the Ids for a set of PoolProcessors |
osid.id.Id | poolId | the Id of a Pool | |
Errors | NOT_FOUND | poolId not found or, a poolProcessorId not
related to poolId | |
NULL_ARGUMENT | poolProcessorIds or poolId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |