Interface | osid.provisioning.QueueDistributorAssignmentSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to re-assign Adding a reference of a | ||
Method | canAssignQueues | ||
Description |
Tests if this user can alter queue/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 | canAssignQueuesToDistributor | ||
Description |
Tests if this user can alter queue/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 queue 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 | getAssignableDistributorIdsForQueue | ||
Description |
Gets a list of distributors including and under the given distributor node in which a specific queue can be assigned. | ||
Parameters | osid.id.Id | distributorId | the Id of the Distributor |
osid.id.Id | queueId | the Id of the Queue | |
Return | osid.id.IdList | list of assignable distributor Ids | |
Errors | NULL_ARGUMENT | distributorId or queueId is null
| |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | assignQueueToDistributor | ||
Description |
Adds an existing | ||
Parameters | osid.id.Id | queueId | the Id of the Queue |
osid.id.Id | distributorId | the Id of the Distributor | |
Errors | ALREADY_EXISTS | queueId is already assigned to distributorId | |
NOT_FOUND | queueId or distributorId not found | ||
NULL_ARGUMENT | queueId or distributorId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | unassignQueueFromDistributor | ||
Description |
Removes a | ||
Parameters | osid.id.Id | queueId | the Id of the Queue |
osid.id.Id | distributorId | the Id of the Distributor | |
Errors | NOT_FOUND | queueId or distributorId not found or
queueId not assigned to distributorId | |
NULL_ARGUMENT | queueId or distributorId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |