OSID - osid.lexicon.ParameterQuery Service Interface Definition

Interface	osid.lexicon.ParameterQuery
Implements	`osid.OsidObjectQuery`
Implements	`osid.OsidSubjugateableQuery`
Used By	`osid.lexicon.ParameterQuerySession`
	`osid.lexicon.ParameterSearchSession`
	`osid.lexicon.ParameterSmartPressSession`
	`osid.lexicon.PressQuery`
Description	This is the query for searching parameters. 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	matchSyntax
Description	Adds a match for parameters of a given syntax. Multiple matches can be added to perform a boolean `OR` among them.
Parameters	`osid.Syntax`	`syntax`	the parameter syntax
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`syntax` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnySyntax
Description	Matches parameters that have any synatx.
Parameters	`boolean`	`match`	`true` to match parameters with any synatx, `false` to match parameters with no synatx set
Compliance	`mandatory`		This method must be implemented.
Method	clearSyntaxTerms
Description	Clears the syntax terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchInputPosition
Description	Matches parameters whose input position is in the given range inclusive,.
Parameters	`cardinal`	`start`	start of range
	`cardinal`	`end`	end of range
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`start` is greater than `end`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyInputPosition
Description	Matches parameters with any input position set.
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Compliance	`mandatory`		This method must be implemented.
Method	clearInputPositionTerms
Description	Clears the input position 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	getParameterQueryRecord
Description	Gets the parameter query record corresponding to the given `Parameter` record `Type`. Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`parameterRecordType`	a parameter record type
Return	`osid.lexicon.records.ParameterQueryRecord`		the parameter query record
Errors	NULL_ARGUMENT		`parameterRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(parameterRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.