| Interface | osid.tracking.rules.QueueEnablerSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Used By | osid.tracking.rules.QueueEnablerSearchSession | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getQueueEnablers | ||
| Description |
Gets the queue enabler list resulting from a search. | ||
| Return | osid.tracking.rules.QueueEnablerList | the queue enabler list | |
| Errors | ILLEGAL_STATE | list already retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getQueueEnablerQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terms used in the search. | ||
| Return | osid.tracking.rules.QueueEnablerQueryInspector | the queue enabler query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getQueueEnablerSearchResultsRecord | ||
| Description |
Gets the queue enabler search results record
corresponding to the given queue enabler search record
| ||
| Parameters | osid.type.Type | queueEnablerSearchRecordType | a queue enabler search record type |
| Return | osid.tracking.rules.records.QueueEnablerSearchResultsRecord | the queue enabler search results record | |
| Errors | NULL_ARGUMENT | queueEnablerSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(queueEnablerSearchRecordType) is
false | ||
| Compliance | mandatory | This method must be implemented. | |