OSID - osid.lexicon.PressQuery Service Interface Definition

Interface	osid.lexicon.PressQuery
Implements	`osid.OsidCatalogQuery`
Used By	`osid.lexicon.IdiomQuery`
	`osid.lexicon.ParameterQuery`
	`osid.lexicon.PressQuery`
	`osid.lexicon.PressQuerySession`
	`osid.lexicon.PressSearchSession`
	`osid.lexicon.TextQuery`
Description	This is the query for searching presses. 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	matchAnyText
Description	Matches presses that have any text.
Parameters	`boolean`	`match`	`true` to match presses with any text, `false` to match presses with no text
Compliance	`mandatory`		This method must be implemented.
Method	clearTextTerms
Description	Clears the text query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchIdiomId
Description	Sets the idiom `Id` for this query.
Parameters	`osid.id.Id`	`idiomId`	the idiom `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`idiomId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearIdiomIdTerms
Description	Clears the idiom `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsIdiomQuery
Description	Tests if a `IdiomQuery` is available.
Return	`boolean`		`true` if an idiom query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getIdiomQuery
Description	Gets the query for an idiom. Multiple retrievals produce a nested `OR` term.
Return	`osid.lexicon.IdiomQuery`		the idiom query
Errors	UNIMPLEMENTED		`supportsIdiomQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsIdiomQuery()` is `true`.
Method	matchAnyIdiom
Description	Matches action groups with any idiom.
Parameters	`boolean`	`match`	`true` to match presses with any idiom, `false` to match presses with no idiom
Compliance	`mandatory`		This method must be implemented.
Method	clearIdiomTerms
Description	Clears the idiom query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchParameterId
Description	Sets the parameter `Id` for this query.
Parameters	`osid.id.Id`	`parameterId`	the parameter `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`parameterId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearParameterIdTerms
Description	Clears the parameter `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsParameterQuery
Description	Tests if a `ParameterQuery` is available.
Return	`boolean`		`true` if a parameter query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getParameterQuery
Description	Gets the query for a parameter. Multiple retrievals produce a nested `OR` term.
Return	`osid.lexicon.ParameterQuery`		the parameter query
Errors	UNIMPLEMENTED		`supportsParameterQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsParameterQuery()` is `true`.
Method	matchAnyParameter
Description	Matches presses with any parameter.
Parameters	`boolean`	`match`	`true` to match presses with any parameter, `false` to match presses with no parameter
Compliance	`mandatory`		This method must be implemented.
Method	clearParameterTerms
Description	Clears the parameter query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAncestorPressId
Description	Sets the press `Id` for this query to match presses that have the specified press as an ancestor.
Parameters	`osid.id.Id`	`pressId`	an press `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for negative match
Errors	NULL_ARGUMENT		`pressId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAncestorPressIdTerms
Description	Clears the ancestor press `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAncestorPressQuery
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	getAncestorPressQuery
Description	Gets the query for an press. Multiple retrievals produce a nested `OR` term.
Return	`osid.lexicon.PressQuery`		the press query
Errors	UNIMPLEMENTED		`supportsAncestorPressQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAncestorPressQuery()` is `true`.
Method	matchAnyAncestorPress
Description	Matches presses with any ancestor.
Parameters	`boolean`	`match`	`true` to match presses with any ancestor, `false` to match root presses
Compliance	`mandatory`		This method must be implemented.
Method	clearAncestorPressTerms
Description	Clears the ancestor press query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDescendantPressId
Description	Sets the press `Id` for this query to match presses that have the specified press as a descendant.
Parameters	`osid.id.Id`	`pressId`	an press `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for negative match
Errors	NULL_ARGUMENT		`pressId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearDescendantPressIdTerms
Description	Clears the descendant press `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsDescendantPressQuery
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	getDescendantPressQuery
Description	Gets the query for an press/ Multiple retrievals produce a nested `OR` term.
Return	`osid.lexicon.PressQuery`		the press query
Errors	UNIMPLEMENTED		`supportsDescendantPressQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDescendantPressQuery()` is `true`.
Method	matchAnyDescendantPress
Description	Matches presses with any descendant.
Parameters	`boolean`	`match`	`true` to match presses with any descendant, `false` to match leaf presses
Compliance	`mandatory`		This method must be implemented.
Method	clearDescendantPressTerms
Description	Clears the descendant press query terms.
Compliance	`mandatory`		This method must be implemented.
Method	getPressQueryRecord
Description	Gets the press query record corresponding to the given `Press` record `Type`.Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`pressRecordType`	a press record type
Return	`osid.lexicon.records.PressQueryRecord`		the press query record
Errors	NULL_ARGUMENT		`pressRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(pressRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.