Interface | osid.tracking.rules.QueueConstrainerEnablerFrontOfficeSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to retrieve This lookup session defines several views:
| ||
Method | canLookupQueueConstrainerEnablerFrontOfficeMappings | ||
Description |
Tests if this user can perform lookups of queue
constrainer enabler/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 | useComparativeQueueConstrainerEnablerFrontOfficeView | ||
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 | usePlenaryQueueConstrainerEnablerFrontOfficeView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getQueueConstrainerEnablerIdsByFrontOffice | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | frontOfficeId | Id of the FrontOffice |
Return | osid.id.IdList | list of related queue constrainer enabler 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 | getQueueConstrainerEnablersByFrontOffice | ||
Description |
Gets the list of queue constrainer enablers associated
with an | ||
Parameters | osid.id.Id | frontOfficeId | Id of the FrontOffice |
Return | osid.tracking.rules.QueueConstrainerEnablerList | list of related queue constrainer enablers | |
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 | getQueueConstrainerEnablerIdsByFrontOffices | ||
Description |
Gets the list of | ||
Parameters | osid.id.IdList | frontOfficeIds | list of front office Ids |
Return | osid.id.IdList | list of queue constrainer enabler 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 | getQueueConstrainerEnablersByFrontOffices | ||
Description |
Gets the list of queue constrainer enablers
corresponding to a list of | ||
Parameters | osid.id.IdList | frontOfficeIds | list of front office Ids |
Return | osid.tracking.rules.QueueConstrainerEnablerList | list of queue constrainer enablers | |
Errors | NULL_ARGUMENT | frontOfficeIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getFrontOfficeIdsByQueueConstrainerEnabler | ||
Description |
Gets the | ||
Parameters | osid.id.Id | queueConstrainerEnablerId | Id of a QueueConstrainerEnabler |
Return | osid.id.IdList | list of offices | |
Errors | NOT_FOUND | queueConstrainerEnablerId is not found | |
NULL_ARGUMENT | queueConstrainerEnablerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getFrontOfficesByQueueConstrainerEnabler | ||
Description |
Gets the | ||
Parameters | osid.id.Id | queueConstrainerEnablerId | Id of a QueueConstrainerEnabler |
Return | osid.tracking.FrontOfficeList | list of offices | |
Errors | NOT_FOUND | queueConstrainerEnablerId is not found | |
NULL_ARGUMENT | queueConstrainerEnablerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |