OSID Logo
OSID Specifications
rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.rules.EngineQuerySession
Implementsosid.OsidSession
Description

This session provides methods for searching Engine objects. The search query is constructed using the EngineQuery. The engine record Type also specifies the record for the engine query.

Engines may have an engine query record indicated by their respective record types. The engine query record is accessed via the EngineQuery. The returns in this session may not be cast directly to these interfaces.

MethodcanSearchEngines
Description

Tests if this user can perform Engine searches. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer search operations to unauthorized users.

Returnboolean false if search methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetEngineQuery
Description

Gets an engine query.

Returnosid.rules.EngineQuerythe engine query
CompliancemandatoryThis method must be implemented.
MethodgetEnginesByQuery
Description

Gets a list of Engines matching the given search.

Parametersosid.rules.EngineQueryengineQuerythe engine query
Returnosid.rules.EngineListthe returned EngineList
ErrorsNULL_ARGUMENT engineQuery is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED engineQuery is not of this service
CompliancemandatoryThis method must be implemented.