Interface | osid.tracking.rules.QueueProcessorSearchSession | ||
---|---|---|---|
Implements | osid.tracking.rules.QueueProcessorQuerySession | ||
Description |
This session provides methods for searching among This session defines views that offer differing behaviors for searching.
| ||
Method | getQueueProcessorSearch | ||
Description |
Gets a queue processor search. | ||
Return | osid.tracking.rules.QueueProcessorSearch | the queue processor search | |
Compliance | mandatory | This method must be implemented. | |
Method | getQueueProcessorSearchOrder | ||
Description |
Gets a queue processor search order. The | ||
Return | osid.tracking.rules.QueueProcessorSearchOrder | the queue processor search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getQueueProcessorsBySearch | ||
Description |
Gets the search results matching the given search query using the given search. | ||
Parameters | osid.tracking.rules.QueueProcessorQuery | queueProcessorQuery | the queue processor query |
osid.tracking.rules.QueueProcessorSearch | queueProcessorSearch | the queue processor search | |
Return | osid.tracking.rules.QueueProcessorSearchResults | the returned search results | |
Errors | NULL_ARGUMENT | queueProcessorQuery or queueProcessorSearch
is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | queueProcessorQuery or queueProcessorSearch
is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getQueueProcessorQueryFromInspector | ||
Description |
Gets a queue processor query from an inspector. The
inspector is available from a | ||
Parameters | osid.tracking.rules.QueueProcessorQueryInspector | queueProcessorQueryInspector | a queue processor query inspector |
Return | osid.tracking.rules.QueueProcessorQuery | the queue processor query | |
Errors | NULL_ARGUMENT | queueProcessorQueryInspector is null | |
UNSUPPORTED | queueProcessorQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |