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

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

getEnginesByQuery() is the basic search method and returns a list of Engine elements. A more advanced search may be performed with getEnginesBySearch(). It accepts an EngineSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getEnginesBySearch() returns a EngineSearchResults that can be used to access the resulting EngineList or be used to perform a search within the result set through EngineSearch.

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.

MethodgetEngineSearch
Description

Gets an engine search.

Returnosid.rules.EngineSearchthe engine search
CompliancemandatoryThis method must be implemented.
MethodgetEngineSearchOrder
Description

Gets an engine search order. The EngineSearchOrder is supplied to a EngineSearch to specify the ordering of results.

Returnosid.rules.EngineSearchOrderthe engine search order
CompliancemandatoryThis method must be implemented.
MethodgetEnginesBySearch
Description

Gets the search results matching the given search.

Parametersosid.rules.EngineQueryengineQuerythe engine query
osid.rules.EngineSearchengineSearchthe engine search
Returnosid.rules.EngineSearchResultsthe engine search results
ErrorsNULL_ARGUMENT engineQuery or engineSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED engineQuery or engineSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetEngineQueryFromInspector
Description

Gets an engine query from an inspector. The inspector is available from a EngineSearchResults.

Parametersosid.rules.EngineQueryInspectorengineQueryInspectoran engine query inspector
Returnosid.rules.EngineQuerythe engine query
ErrorsNULL_ARGUMENT engineQueryInspector is null
UNSUPPORTED engineQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.