OSID - osid.lexicon.TextQuery Service Interface Definition

Interface	osid.lexicon.TextQuery
Implements	`osid.OsidObjectQuery`
Used By	`osid.lexicon.IdiomQuery`
	`osid.lexicon.ParameterQuery`
	`osid.lexicon.PressQuery`
	`osid.lexicon.TextQuerySession`
	`osid.lexicon.TextSearchSession`
	`osid.lexicon.TextSmartPressSession`
	`osid.rules.check.CheckQuery`
Description	This is the query for searching texts. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	clearTextReturnTerms
Description	Clears the text return query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchPressId
Description	Sets the press `Id` for this query to match texts assigned to presses.
Parameters	`osid.id.Id`	`pressId`	the press `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`pressId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearPressIdTerms
Description	Clears the press `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsPressQuery
Description	Tests if a `PressQuery` is available.
Return	`boolean`		`true` if an press query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getPressQuery
Description	Gets the query for an press. Multiple retrievals produce a nested `OR` term.
Return	`osid.lexicon.PressQuery`		the press query
Errors	UNIMPLEMENTED		`supportsPressQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPressQuery()` is `true`.
Method	clearPressTerms
Description	Clears the press query terms.
Compliance	`mandatory`		This method must be implemented.
Method	getTextQueryRecord
Description	Gets the text query record corresponding to the given `Text` record `Type`.Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`textRecordType`	a text record type
Return	`osid.lexicon.records.TextQueryRecord`		the text query record
Errors	NULL_ARGUMENT		`textRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(textRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.