Interface | osid.provisioning.rules.PoolConstrainerRuleApplicationSession | ||
---|---|---|---|
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 | canAssignPoolConstrainers | ||
Description |
Tests if this user can alter pool constrainer/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 | assignPoolConstrainerToPool | ||
Description |
Adds an existing | ||
Parameters | osid.id.Id | poolConstrainerId | the Id of the PoolConstrainer |
osid.id.Id | poolId | the Id of the Pool | |
Errors | ALREADY_EXISTS | poolConstrainerId is already applied to poolId
| |
NOT_FOUND | poolConstrainerId or poolId not found | ||
NULL_ARGUMENT | poolConstrainerId or poolId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | unassignPoolConstrainerFromPool | ||
Description |
Removes a | ||
Parameters | osid.id.Id | poolConstrainerId | the Id of the PoolConstrainer |
osid.id.Id | poolId | the Id of the Pool | |
Errors | NOT_FOUND | poolConstrainerId or poolId not found or
poolConstrainerId not applied to poolId | |
NULL_ARGUMENT | poolConstrainerId or poolId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canSequencePoolConstrainers | ||
Description |
Tests if this user can order | ||
Return | boolean | false if PoolConstrainer ordering is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | movePoolConstrainerAhead | ||
Description |
Reorders pool constrainers for a pool by moving the specified pool constrainer in front of a reference pool constrainer. | ||
Parameters | osid.id.Id | poolConstrainerId | the Id of a PoolConstrainer |
osid.id.Id | poolId | the Id of a Pool | |
osid.id.Id | referenceId | the reference pool constrainer Id | |
Errors | NOT_FOUND | poolConstrainerId, poolId, or referenceId not
found or, poolConstrainerId or referenceId not
related to poolId | |
NULL_ARGUMENT | poolConstrainerId, poolId, or referenceId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | movePoolConstrainerBehind | ||
Description |
Reorders pool constrainers for a pool by moving the specified pool constrainer behind a reference pool constrainer. | ||
Parameters | osid.id.Id | poolConstrainerId | the Id of a PoolConstrainer |
osid.id.Id | poolId | the Id of a Pool | |
osid.id.Id | referenceId | the reference pool constrainer Id | |
Errors | NOT_FOUND | poolConstrainerId, poolId, or referenceId not
found or, poolConstrainerId or referenceId not
related to poolId | |
NULL_ARGUMENT | poolConstrainerId, poolId, or referenceId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | orderPoolConstrainers | ||
Description |
Reorders a set of pool constrainers for a pool. | ||
Parameters | osid.id.Id[] | poolConstrainerIds | the Ids for a set of PoolConstrainers |
osid.id.Id | poolId | the Id of a Pool | |
Errors | NOT_FOUND | poolId not found or, a poolConstrainerId not
related to poolId | |
NULL_ARGUMENT | poolConstrainerIds or poolId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |