Interface | osid.tracking.QueueFrontOfficeSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to retrieve This lookup session defines several views:
| ||
Method | canLookupQueueFrontOfficeIssues | ||
Description |
Tests if this user can perform lookups of queue/front
office mappings. A return of true does not guarantee
successful authorization. A return of false indicates that
it is known lookup methods in this session will result in
a | ||
Return | boolean | false if looking up mappings is not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeQueueFrontOfficeView | ||
Description |
The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | usePlenaryQueueFrontOfficeView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getQueueIdsByFrontOffice | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | frontOfficeId | Id of the FrontOffice |
Return | osid.id.IdList | list of related queue Ids | |
Errors | NOT_FOUND | frontOfficeId is not found | |
NULL_ARGUMENT | frontOfficeId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getQueuesByFrontOffice | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | frontOfficeId | Id of the FrontOffice |
Return | osid.tracking.QueueList | list of related queues | |
Errors | NOT_FOUND | frontOfficeId is not found | |
NULL_ARGUMENT | frontOfficeId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getQueueIdsByFrontOffices | ||
Description |
Gets the list of | ||
Parameters | osid.id.IdList | frontOfficeIds | list of front office Ids |
Return | osid.id.IdList | list of queue Ids | |
Errors | NULL_ARGUMENT | frontOfficeIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getQueuesByFrontOffices | ||
Description |
Gets the list of | ||
Parameters | osid.id.IdList | frontOfficeIds | list of front office Ids |
Return | osid.tracking.QueueList | list of queues | |
Errors | NULL_ARGUMENT | frontOfficeIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getFrontOfficeIdsByQueue | ||
Description |
Gets the | ||
Parameters | osid.id.Id | queueId | Id of a Queue |
Return | osid.id.IdList | list of frontOffices | |
Errors | NOT_FOUND | queueId is not found | |
NULL_ARGUMENT | queueId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getFrontOfficesByQueue | ||
Description |
Gets the | ||
Parameters | osid.id.Id | queueId | Id of a Queue |
Return | osid.tracking.FrontOfficeList | list of frontOffices | |
Errors | NOT_FOUND | queueId is not found | |
NULL_ARGUMENT | queueId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |