Interface | osid.provisioning.PoolDistributorAssignmentSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to re-assign Adding a reference of a | ||
Method | canAssignPools | ||
Description |
Tests if this user can alter pool/distributor 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 pool assignment is not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canAssignPoolsToDistributor | ||
Description |
Tests if this user can alter pool/distributor 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
| ||
Parameters | osid.id.Id | distributorId | the Id of the Distributor |
Return | boolean | false if pool assignment is not authorized, true
otherwise | |
Errors | NULL_ARGUMENT | distributorId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getAssignableDistributorIds | ||
Description |
Gets a list of distributors including and under the given distributor node in which any pool can be assigned. | ||
Parameters | osid.id.Id | distributorId | the Id of the Distributor |
Return | osid.id.IdList | list of assignable distributor Ids | |
Errors | NULL_ARGUMENT | distributorId is null | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAssignableDistributorIdsForPool | ||
Description |
Gets a list of distributors including and under the given distributor node in which a specific pool can be assigned. | ||
Parameters | osid.id.Id | distributorId | the Id of the Distributor |
osid.id.Id | poolId | the Id of the Pool | |
Return | osid.id.IdList | list of assignable distributor Ids | |
Errors | NULL_ARGUMENT | distributorId or poolId is null
| |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | assignPoolToDistributor | ||
Description |
Adds an existing | ||
Parameters | osid.id.Id | poolId | the Id of the Pool |
osid.id.Id | distributorId | the Id of the Distributor | |
Errors | ALREADY_EXISTS | poolId is already assigned to distributorId | |
NOT_FOUND | poolId or distributorId not found | ||
NULL_ARGUMENT | poolId or distributorId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | unassignPoolFromDistributor | ||
Description |
Removes a | ||
Parameters | osid.id.Id | poolId | the Id of the Pool |
osid.id.Id | distributorId | the Id of the Distributor | |
Errors | NOT_FOUND | poolId or distributorId not found or
poolId not assigned to distributorId | |
NULL_ARGUMENT | poolId or distributorId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |