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