Interface | osid.provisioning.QueueSearchSession | ||
---|---|---|---|
Implements | osid.provisioning.QueueQuerySession | ||
Description |
This session provides methods for searching among This session defines views that offer differing behaviors for searching.
Queues may have a queue record indicated by their
respective record types. The queue record is accessed via the
| ||
Method | getQueueSearch | ||
Description |
Gets a queue search. | ||
Return | osid.provisioning.QueueSearch | the queue search | |
Compliance | mandatory | This method must be implemented. | |
Method | getQueueSearchOrder | ||
Description |
Gets a queue search order. The | ||
Return | osid.provisioning.QueueSearchOrder | the queue search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getQueuesBySearch | ||
Description |
Gets the search results matching the given search query using the given search. | ||
Parameters | osid.provisioning.QueueQuery | queueQuery | the queue query |
osid.provisioning.QueueSearch | queueSearch | the queue search | |
Return | osid.provisioning.QueueSearchResults | the queue search results | |
Errors | NULL_ARGUMENT | queueQuery or queueSearch is null
| |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | queueQuery or queueSearch is not of this
service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getQueueQueryFromInspector | ||
Description |
Gets a queue query from an inspector. The inspector is
available from a | ||
Parameters | osid.provisioning.QueueQueryInspector | queueQueryInspector | a queue query inspector |
Return | osid.provisioning.QueueQuery | the queue query | |
Errors | NULL_ARGUMENT | queueQueryInspector is null | |
UNSUPPORTED | queueQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |