| Interface | osid.tracking.rules.QueueConstrainerFrontOfficeAssignmentSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Description |
This session provides methods to re-assign Adding a reference of a | ||
| Method | canAssignQueueConstrainers | ||
| Description |
Tests if this user can alter queue constrainer/office
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 | canAssignQueueConstrainersToFrontOffice | ||
| Description |
Tests if this user can alter queue constrainer/office
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 | 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 office including and under the given front office node in which any queue constrainer 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 | getAssignableFrontOfficeIdsForQueueConstrainer | ||
| Description |
Gets a list of front office including and under the given front office node in which a specific queue constrainer can be assigned. | ||
| Parameters | osid.id.Id | frontOfficeId | the Id of the FrontOffice |
osid.id.Id | queueConstrainerId | the Id of the QueueConstrainer | |
| Return | osid.id.IdList | list of assignable front office Ids | |
| Errors | NULL_ARGUMENT | frontOfficeId or queueConstrainerId is
null | |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | assignQueueConstrainerToFrontOffice | ||
| Description |
Adds an existing | ||
| Parameters | osid.id.Id | queueConstrainerId | the Id of the QueueConstrainer |
osid.id.Id | frontOfficeId | the Id of the FrontOffice | |
| Errors | ALREADY_EXISTS | queueConstrainerId is already assigned to
frontOfficeId | |
| NOT_FOUND | queueConstrainerId or frontOfficeId not found | ||
| NULL_ARGUMENT | queueConstrainerId or frontOfficeId is
null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | unassignQueueConstrainerFromFrontOffice | ||
| Description |
Removes a | ||
| Parameters | osid.id.Id | queueConstrainerId | the Id of the QueueConstrainer |
osid.id.Id | frontOfficeId | the Id of the FrontOffice | |
| Errors | NOT_FOUND | queueConstrainerId or frontOfficeId not found
or queueConstrainerId not assigned to frontOfficeId
| |
| NULL_ARGUMENT | queueConstrainerId or frontOfficeId is
null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |