Interface | osid.provisioning.rules.PoolConstrainerDistributorAssignmentSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to re-assign Adding a reference of a | ||
Method | canAssignPoolConstrainers | ||
Description |
Tests if this user can alter pool
constrainer/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 mapping is not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canAssignPoolConstrainersToDistributor | ||
Description |
Tests if this user can alter pool
constrainer/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 mapping 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 constrainer 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 | getAssignableDistributorIdsForPoolConstrainer | ||
Description |
Gets a list of distributors including and under the given distributor node in which a specific pool constrainer can be assigned. | ||
Parameters | osid.id.Id | distributorId | the Id of the Distributor |
osid.id.Id | poolConstrainerId | the Id of the PoolConstrainer | |
Return | osid.id.IdList | list of assignable distributor Ids | |
Errors | NULL_ARGUMENT | distributorId or poolConstrainerId is
null | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | assignPoolConstrainerToDistributor | ||
Description |
Adds an existing | ||
Parameters | osid.id.Id | poolConstrainerId | the Id of the PoolConstrainer |
osid.id.Id | distributorId | the Id of the Distributor | |
Errors | ALREADY_EXISTS | poolConstrainerId is already assigned to
distributorId | |
NOT_FOUND | poolConstrainerId or distributorId not found | ||
NULL_ARGUMENT | poolConstrainerId or distributorId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | unassignPoolConstrainerFromDistributor | ||
Description |
Removes a | ||
Parameters | osid.id.Id | poolConstrainerId | the Id of the PoolConstrainer |
osid.id.Id | distributorId | the Id of the Distributor | |
Errors | NOT_FOUND | poolConstrainerId or distributorId not found
or poolConstrainerId not assigned to distributorId
| |
NULL_ARGUMENT | poolConstrainerId or distributorId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |