OSID - osid.search.EngineQuery Service Interface Definition

Interface	osid.search.EngineQuery
Implements	`osid.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.`
Method	matchAncestorEngineId
Description	Sets the engine `Id` for this query to match engines that have the specified engine as an ancestor.
Parameters	`osid.id.Id`	`engineId`	an engine `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for negative match
Errors	NULL_ARGUMENT		`engineId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAncestorEngineIdTerms
Description	Clears all ancestor engine `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAncestorEngineQuery
Description	Tests if an `EngineQuery` is available.
Return	`boolean`		`true` if an engine query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAncestorEngineQuery
Description	Gets the query for an engine. Multiple retrievals produce a nested `OR` term.
Return	`osid.search.EngineQuery`		the engine query
Errors	UNIMPLEMENTED		`supportsAncestorEngineQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAncestorEngineQuery()` is `true.`
Method	matchAnyAncestorEngine
Description	Matches engines with any ancestor.
Parameters	`boolean`	`match`	`true` to match engine with any ancestor, `false` to match root engines
Compliance	`mandatory`		This method must be implemented.
Method	clearAncestorEngineTerms
Description	Clears all ancestor engine terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDescendantEngineId
Description	Sets the engine `Id` for this query to match engines that have the specified engine as a descendant.
Parameters	`osid.id.Id`	`engineId`	an engine `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for negative match
Errors	NULL_ARGUMENT		`engineId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearDescendantEngineIdTerms
Description	Clears all descendant engine `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsDescendantEngineQuery
Description	Tests if an `EngineQuery` is available.
Return	`boolean`		`true` if an engine query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getDescendantEngineQuery
Description	Gets the query for an engine. Multiple retrievals produce a nested `OR` term.
Return	`osid.search.EngineQuery`		the engine query
Errors	UNIMPLEMENTED		`supportsDescendantEngineQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDescendantEngineQuery()` is `true.`
Method	matchAnyDescendantEngine
Description	Matches engines with any descendant.
Parameters	`boolean`	`match`	`true` to match engine with any descendant, `false` to match leaf engines
Compliance	`mandatory`		This method must be implemented.
Method	clearDescendantEngineTerms
Description	Clears all descendant engine terms.
Compliance	`mandatory`		This method must be implemented.
Method	getEngineQueryRecord
Description	Gets the engine query record corresponding to the given `Engine` record `Type.` Multiple record retrievals produce a nested boolean `OR` term.
Parameters	`osid.type.Type`	`engineRecordType`	an engine record type
Return	`osid.search.records.EngineQueryRecord`		the engine query record
Errors	NULL_ARGUMENT		`engineRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`hasRecordType(engineRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.