Interface | osid.tracking.QueueSearchResults | ||
---|---|---|---|
Implements | osid.OsidSearchResults | ||
Description |
This interface provides a means to capture results of a search. | ||
Method | getQueues | ||
Description |
Gets the queue list resulting from a search. | ||
Return | osid.tracking.QueueList | the queue list | |
Errors | ILLEGAL_STATE | list already retrieved | |
Compliance | mandatory | This method must be implemented. | |
Method | getQueueQueryInspector | ||
Description |
Gets the inspector for the query to examine the terms used in the search. | ||
Return | osid.tracking.QueueQueryInspector | the queue query inspector | |
Compliance | mandatory | This method must be implemented. | |
Method | getQueueSearchResultsRecord | ||
Description |
Gets the queue search record corresponding to the given
queue search record | ||
Parameters | osid.type.Type | queueSearchRecordType | a queue search record type |
Return | osid.tracking.records.QueueSearchResultsRecord | the queue search results record | |
Errors | NULL_ARGUMENT | queueSearchRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(queueSearchRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |