Interface | osid.rules.EngineSearch | ||
---|---|---|---|
Implements | osid.OsidSearch | ||
Description |
The search interface for governing engine searches. | ||
Method | searchAmongEngines | ||
Description |
Execute this search among the given list of engines. | ||
Parameters | osid.id.IdList | engineIds | list of engines |
Errors | NULL_ARGUMENT | engineIds is null | |
Compliance | mandatory | This method must be implemented. | |
Method | orderEngineResults | ||
Description |
Specify an ordering to the search results. | ||
Parameters | osid.rules.EngineSearchOrder | engineSearchOrder | engine search order |
Errors | NULL_ARGUMENT | engineSearchOrder is null | |
UNSUPPORTED | engineSearchOrder is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getEngineSearchRecord | ||
Description |
Gets the engine search record corresponding to the
given engine search record | ||
Parameters | osid.type.Type | engineSearchRecordType | an engine search record type |
Return | osid.rules.records.EngineSearchRecord | the engine search 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. |