OSID Specifications
tracking package
Version 3.0.0
Release Candidate Preview
tracking package
Version 3.0.0
Release Candidate Preview
| Interface | osid.tracking.QueueSearch | ||
|---|---|---|---|
| Implements | osid.OsidSearch | ||
| Description |
The search interface for governing queue searches. | ||
| Method | searchAmongQueues | ||
| Description |
Execute this search among the given list of queues. | ||
| Parameters | osid.id.IdList | queueIds | list of queues |
| Errors | NULL_ARGUMENT | queueIds is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | orderQueueResults | ||
| Description |
Specify an ordering to the search results. | ||
| Parameters | osid.tracking.QueueSearchOrder | queueSearchOrder | queue search order |
| Errors | NULL_ARGUMENT | queueSearchOrder is null | |
| UNSUPPORTED | queueSearchOrder is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getQueueSearchRecord | ||
| 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.QueueSearchRecord | the queue search 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. | |