Interface | osid.rules.EngineSearchSession | ||
---|---|---|---|
Implements | osid.rules.EngineQuerySession | ||
Description |
This session provides methods for searching Engines may have an engine query record indicated by their
respective record types. The engine query record is accessed
via the | ||
Method | getEngineSearch | ||
Description |
Gets an engine search. | ||
Return | osid.rules.EngineSearch | the engine search | |
Compliance | mandatory | This method must be implemented. | |
Method | getEngineSearchOrder | ||
Description |
Gets an engine search order. The | ||
Return | osid.rules.EngineSearchOrder | the engine search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getEnginesBySearch | ||
Description |
Gets the search results matching the given search. | ||
Parameters | osid.rules.EngineQuery | engineQuery | the engine query |
osid.rules.EngineSearch | engineSearch | the engine search | |
Return | osid.rules.EngineSearchResults | the engine search results | |
Errors | NULL_ARGUMENT | engineQuery or engineSearch is null
| |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | engineQuery or engineSearch is not of this
service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getEngineQueryFromInspector | ||
Description |
Gets an engine query from an inspector. The inspector
is available from a | ||
Parameters | osid.rules.EngineQueryInspector | engineQueryInspector | an engine query inspector |
Return | osid.rules.EngineQuery | the engine query | |
Errors | NULL_ARGUMENT | engineQueryInspector is null | |
UNSUPPORTED | engineQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |