| Interface | osid.tracking.QueueFrontOfficeAssignmentSession | ||
|---|---|---|---|
| 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/front office
mappings. A return of true does not guarantee successful
authorization. A return of false indicates that it is
known issue 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 | canAssignQueuesToFrontOffice | ||
| Description |
Tests if this user can alter queue/front office
mappings. A return of true does not guarantee successful
authorization. A return of false indicates that it is
known issue methods in this session will result in a
| ||
| Parameters | osid.id.Id | frontOfficeId | the Id of the FrontOffice |
| Return | boolean | false if mapping is not authorized, true
otherwise | |
| Errors | NULL_ARGUMENT | frontOfficeId is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAssignableFrontOfficeIds | ||
| Description |
Gets a list of front offices including and under the given front office node in which any queue can be assigned. | ||
| Parameters | osid.id.Id | frontOfficeId | the Id of the FrontOffice |
| Return | osid.id.IdList | list of assignable front office Ids | |
| Errors | NULL_ARGUMENT | frontOfficeId is null | |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getAssignableFrontOfficeIdsForQueue | ||
| Description |
Gets a list of front offices including and under the given front office node in which a specific queue can be assigned. | ||
| Parameters | osid.id.Id | frontOfficeId | the Id of the FrontOffice |
osid.id.Id | queueId | the Id of the Queue | |
| Return | osid.id.IdList | list of assignable front office Ids | |
| Errors | NULL_ARGUMENT | frontOfficeId or queueId is null
| |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | assignQueueToFrontOffice | ||
| Description |
Adds an existing | ||
| Parameters | osid.id.Id | queueId | the Id of the Queue |
osid.id.Id | frontOfficeId | the Id of the FrontOffice | |
| Errors | ALREADY_EXISTS | queueId is already assigned to frontOfficeId | |
| NOT_FOUND | queueId or frontOfficeId not found | ||
| NULL_ARGUMENT | queueId or frontOfficeId is null
| ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | unassignQueueFromFrontOffice | ||
| Description |
Removes a | ||
| Parameters | osid.id.Id | queueId | the Id of the Queue |
osid.id.Id | frontOfficeId | the Id of the FrontOffice | |
| Errors | NOT_FOUND | queueId or frontOfficeId not found or
queueId not assigned to frontOfficeId | |
| NULL_ARGUMENT | queueId or frontOfficeId is null
| ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |