Interface | osid.tracking.QueueQuerySession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods for searching among This session defines views that offer differing behaviors for searching.
Queues may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
Method | getFrontOfficeId | ||
Description |
Gets the | ||
Return | osid.id.Id | the FrontOffice Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getFrontOffice | ||
Description |
Gets the | ||
Return | osid.tracking.FrontOffice | the front office | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canSearchQueues | ||
Description |
Tests if this user can perform | ||
Return | boolean | false if search methods are not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useFederatedFrontOfficeView | ||
Description |
Federates the view for methods in this session. A federated view will include queues in front offices which are children of this front office in the front office hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedFrontOfficeView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts searches to this front office only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getQueueQuery | ||
Description |
Gets a queue query. | ||
Return | osid.tracking.QueueQuery | the queue query | |
Compliance | mandatory | This method must be implemented. | |
Method | getQueuesByQuery | ||
Description |
Gets a list of | ||
Parameters | osid.tracking.QueueQuery | queueQuery | the queue query |
Return | osid.tracking.QueueList | the returned QueueList | |
Errors | NULL_ARGUMENT | queueQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | queueQuery is not of this service | ||
Compliance | mandatory | This method must be implemented. |