OSID Specifications
rules package
Version 3.0.0
Release Candidate Preview
rules package
Version 3.0.0
Release Candidate Preview
| Interface | osid.rules.EngineSearchResults | ||
|---|---|---|---|
| Implements | osid.OsidSearchResults | ||
| Description |
This interface provides a means to capture results of a search. | ||
| Method | getEngines | ||
| Description |
Gets the engine list resulting from a search. | ||
| Return | osid.rules.EngineList | the engine list | |
| Errors | ILLEGAL_STATE | list already retrieved | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getEngineQueryInspector | ||
| Description |
Gets the inspector for the query to examine the terms used in the search. | ||
| Return | osid.rules.EngineQueryInspector | the engine query inspector | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getEngineSearchResultsRecord | ||
| Description |
Gets the engine search results record corresponding to the given engine search record Type. This method is used to retrieve an object implementing the requested record. | ||
| Parameters | osid.type.Type | engineSearchRecordType | an engine search record type |
| Return | osid.rules.records.EngineSearchResultsRecord | the engine search results record | |
| Errors | NULL_ARGUMENT | EngineSearchRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(engineSearchRecordType) is false
| ||
| Compliance | mandatory | This method must be implemented. | |