Interface | osid.search.EngineQuerySession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods for searching Engines may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
Method | canSearchEngines | ||
Description |
Tests if this user can perform | ||
Return | boolean | false if search methods are not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getEngineQuery | ||
Description |
Gets an engine query. | ||
Return | osid.search.EngineQuery | the engine query | |
Compliance | mandatory | This method must be implemented. | |
Method | getEnginesByQuery | ||
Description |
Gets a list of | ||
Parameters | osid.search.EngineQuery | engineQuery | the engine query |
Return | osid.search.EngineList | the returned EngineList | |
Errors | NULL_ARGUMENT | engineQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | engineQuery is not of this service | ||
Compliance | mandatory | This method must be implemented. |