OSID Logo
OSID Specifications
search package
Version 3.0.0
Release Candidate Preview
Interfaceosid.search.EngineQuery
Implementsosid.OsidCatalogQuery
Description

This is the query for searching for engines. Each method specifies an AND term while multiple invocations of the same method produce a nested OR.

MethodmatchAncestorEngineId
Description

Sets the engine Id for this query to match engines that have the specified engine as an ancestor.

Parametersosid.id.IdengineIdan engine Id
booleanmatch true for a positive match, false for negative match
ErrorsNULL_ARGUMENT engineId is null
CompliancemandatoryThis method must be implemented.
MethodclearAncestorEngineIdTerms
Description

Clears all ancestor engine Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsAncestorEngineQuery
Description

Tests if an EngineQuery is available.

Returnboolean true if an engine query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetAncestorEngineQuery
Description

Gets the query for an engine. Multiple retrievals produce a nested OR term.

Returnosid.search.EngineQuerythe engine query
ErrorsUNIMPLEMENTED supportsAncestorEngineQuery() is false
ComplianceoptionalThis method must be implemented if supportsAncestorEngineQuery() is true.
MethodmatchAnyAncestorEngine
Description

Matches engines with any ancestor.

Parametersbooleanmatch true to match engine with any ancestor, false to match root engines
CompliancemandatoryThis method must be implemented.
MethodclearAncestorEngineTerms
Description

Clears all ancestor engine terms.

CompliancemandatoryThis method must be implemented.
MethodmatchDescendantEngineId
Description

Sets the engine Id for this query to match engines that have the specified engine as a descendant.

Parametersosid.id.IdengineIdan engine Id
booleanmatch true for a positive match, false for negative match
ErrorsNULL_ARGUMENT engineId is null
CompliancemandatoryThis method must be implemented.
MethodclearDescendantEngineIdTerms
Description

Clears all descendant engine Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsDescendantEngineQuery
Description

Tests if an EngineQuery is available.

Returnboolean true if an engine query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetDescendantEngineQuery
Description

Gets the query for an engine. Multiple retrievals produce a nested OR term.

Returnosid.search.EngineQuerythe engine query
ErrorsUNIMPLEMENTED supportsDescendantEngineQuery() is false
ComplianceoptionalThis method must be implemented if supportsDescendantEngineQuery() is true.
MethodmatchAnyDescendantEngine
Description

Matches engines with any descendant.

Parametersbooleanmatch true to match engine with any descendant, false to match leaf engines
CompliancemandatoryThis method must be implemented.
MethodclearDescendantEngineTerms
Description

Clears all descendant engine terms.

CompliancemandatoryThis method must be implemented.
MethodgetEngineQueryRecord
Description

Gets the engine query record corresponding to the given Engine record Type. Multiple record retrievals produce a nested boolean OR term.

Parametersosid.type.TypeengineRecordTypean engine record type
Returnosid.search.records.EngineQueryRecordthe engine query record
ErrorsNULL_ARGUMENT engineRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
UNSUPPORTED hasRecordType(engineRecordType) is false
CompliancemandatoryThis method must be implemented.