OSID - osid.lexicon.IdiomQuery Service Interface Definition

Interface	osid.lexicon.IdiomQuery
Implements	`osid.OsidObjectQuery`
Implements	`osid.OsidSubjugateableQuery`
Used By	`osid.lexicon.IdiomQuerySession`
	`osid.lexicon.IdiomSearchSession`
	`osid.lexicon.IdiomSmartPressSession`
	`osid.lexicon.PressQuery`
Description	This is the query for searching idioms. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchTextId
Description	Sets the text `Id` for this query to match presses that have a related affiliation.
Parameters	`osid.id.Id`	`textId`	a text `Id`
Parameters	`boolean`	`match`	`true` if a positive match, `false` for negative match
Errors	NULL_ARGUMENT		`textId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearTextIdTerms
Description	Clears the text `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsTextQuery
Description	Tests if a `TextQuery` is available.
Return	`boolean`		`true` if a text query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getTextQuery
Description	Gets the query for a text. Multiple retrievals produce a nested `OR` term.
Return	`osid.lexicon.TextQuery`		the text query
Errors	UNIMPLEMENTED		`supportsTextQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsTextQuery()` is `true`.
Method	clearTextTerms
Description	Clears the text query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchLanguageType
Description	Matches idioms of the given language type.
Parameters	`osid.type.Type`	`languageType`	a language `Type`
Parameters	`boolean`	`match`	`true` if a positive match, `false` for negative match
Errors	NULL_ARGUMENT		`languageType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyLanguageType
Description	Matches idioms with any known language type.
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Compliance	`mandatory`		This method must be implemented.
Method	clearLanguageTypeTerms
Description	Clears the language type query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchScriptType
Description	Matches idioms of the given script type.
Parameters	`osid.type.Type`	`scriptType`	a script `Type`
Parameters	`boolean`	`match`	`true` if a positive match, `false` for negative match
Errors	NULL_ARGUMENT		`scriptType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyScriptType
Description	Matches idioms with any known script type.
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Compliance	`mandatory`		This method must be implemented.
Method	clearScriptTypeTerms
Description	Clears the script type query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchFormatType
Description	Matches idioms of the given format type.
Parameters	`osid.type.Type`	`formatType`	a format `Type`
Parameters	`boolean`	`match`	`true` if a positive match, `false` for negative match
Errors	NULL_ARGUMENT		`formatType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyFormatType
Description	Matches idioms with any known format type.
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Compliance	`mandatory`		This method must be implemented.
Method	clearFormatTypeTerms
Description	Clears the format type query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchTemplate
Description	Matches idioms of the given template.
Parameters	`string`	`template`	a template
	`osid.type.Type`	`stringMatchType`	a string match type
	`boolean`	`match`	`true` if a positive match, `false` for negative match
Errors	NULL_ARGUMENT		`template` or `stringMatchType` is `null`
Errors	UNSUPPORTED		`supportsStringMatchType(stringMatchType)` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyTemplate
Description	Matches idioms with any template.
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Compliance	`mandatory`		This method must be implemented.
Method	clearTemplateTerms
Description	Clears the template query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchPressId
Description	Sets the action group `Id` for this query to match parameters assigned to action groups.
Parameters	`osid.id.Id`	`actionGroupId`	the action group `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`actionGroupId` 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	getIdiomQueryRecord
Description	Gets the idiom query record corresponding to the given `Idiom` record `Type`.Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`idiomRecordType`	an idiom record type
Return	`osid.lexicon.records.IdiomQueryRecord`		the idiom query record
Errors	NULL_ARGUMENT		`idiomRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(idiomRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.