OSID - osid.offering.CatalogueQuery Service Interface Definition

Interface	osid.offering.CatalogueQuery
Implements	`osid.OsidCatalogQuery`
Description	This is the query for searching for catalogues. Each method specifies an `AND` term while multiple invocations of the same method produce a nested `OR.`
Method	matchCanonicalUnitId
Description	Sets the canonical unit `Id` for this query to match canonical units assigned to catalogues.
Parameters	`osid.id.Id`	`canonicalUnitId`	a canonical unit `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`canonicalUnitId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearCanonicalUnitIdTerms
Description	Clears all canonical unit `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsCanonicalUnitQuery
Description	Tests if a canonical unit query is available.
Return	`boolean`		`true` if a canonical unit query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCanonicalUnitQuery
Description	Gets the query for a catalogue.
Return	`osid.offering.CanonicalUnitQuery`		the canonical unit query
Errors	UNIMPLEMENTED		`supportsCanonicalUnitQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCanonicalUnitQuery()` is `true.`
Method	matchAnyCanonicalUnit
Description	Matches catalogues with any canonical unit.
Parameters	`boolean`	`match`	`true` to match catalogues with any canonical unit, `false` to match catalogues with no canonical units
Compliance	`mandatory`		This method must be implemented.
Method	clearCanonicalUnitTerms
Description	Clears all canonical unit terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchOfferingId
Description	Sets the offering `Id` for this query to match offerings assigned to catalogues.
Parameters	`osid.id.Id`	`offeringId`	an offering `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`offeringId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearOfferingIdTerms
Description	Clears all offering `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsOfferingQuery
Description	Tests if an offering query is available.
Return	`boolean`		`true` if an offering query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getOfferingQuery
Description	Gets the query for an offering.
Return	`osid.offering.OfferingQuery`		the offering query
Errors	UNIMPLEMENTED		`supportsOfferingQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsOfferingQuery()` is `true.`
Method	matchAnyOffering
Description	Matches catalogues with any offering.
Parameters	`boolean`	`match`	`true` to match catalogues with any offering, `false` to match catalogues with no offerings
Compliance	`mandatory`		This method must be implemented.
Method	clearOfferingTerms
Description	Clears all offering terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchParticipantId
Description	Sets the participant `Id` for this query to match participants assigned to catalogues.
Parameters	`osid.id.Id`	`participantId`	a participant `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`participantId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearParticipantIdTerms
Description	Clears all participant `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsParticipantQuery
Description	Tests if a participant query is available.
Return	`boolean`		`true` if a participant query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getParticipantQuery
Description	Gets the query for a participant.
Return	`osid.offering.ParticipantQuery`		the participant query
Errors	UNIMPLEMENTED		`supportsParticipantQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsParticipantQuery()` is `true.`
Method	matchAnyParticipant
Description	Matches catalogues with any participant.
Parameters	`boolean`	`match`	`true` to match catalogues with any participant, `false` to match catalogues with no participants
Compliance	`mandatory`		This method must be implemented.
Method	clearParticipantTerms
Description	Clears all participant terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchResultId
Description	Sets the result `Id` for this query to match results.
Parameters	`osid.id.Id`	`resultId`	an result `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`resultId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearResultIdTerms
Description	Clears all result `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsResultQuery
Description	Tests if an result query is available.
Return	`boolean`		`true` if an result query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getResultQuery
Description	Gets the query for an result.
Return	`osid.offering.ResultQuery`		the result query
Errors	UNIMPLEMENTED		`supportsResultQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsResultQuery()` is `true.`
Method	matchAnyResult
Description	Matches catalogues with any result.
Parameters	`boolean`	`match`	`true` to match catalogues with any result, `false` to match catalogues with no results
Compliance	`mandatory`		This method must be implemented.
Method	clearResultTerms
Description	Clears all result terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAncestorCatalogueId
Description	Sets the catalogue `Id` for this query to match catalogues that have the specified catalogue as an ancestor.
Parameters	`osid.id.Id`	`catalogueId`	a catalogue `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`catalogueId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAncestorCatalogueIdTerms
Description	Clears all ancestor catalogue `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAncestorCatalogueQuery
Description	Tests if a `CatalogueQuery` is available.
Return	`boolean`		`true` if a catalogue query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAncestorCatalogueQuery
Description	Gets the query for a catalogue. Multiple retrievals produce a nested `OR` term.
Return	`osid.offering.CatalogueQuery`		the catalogue query
Errors	UNIMPLEMENTED		`supportsAncestorCatalogueQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAncestorCatalogueQuery()` is `true.`
Method	matchAnyAncestorCatalogue
Description	Matches catalogues with any ancestor.
Parameters	`boolean`	`match`	`true` to match catalogues with any ancestor, `false` to match root catalogues
Compliance	`mandatory`		This method must be implemented.
Method	clearAncestorCatalogueTerms
Description	Clears all ancestor catalogue terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDescendantCatalogueId
Description	Sets the catalogue `Id` for this query to match catalogues that have the specified catalogue as a descendant.
Parameters	`osid.id.Id`	`catalogueId`	a catalogue `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`catalogueId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearDescendantCatalogueIdTerms
Description	Clears all descendant catalogue `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsDescendantCatalogueQuery
Description	Tests if a `CatalogueQuery` is available.
Return	`boolean`		`true` if a catalogue query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getDescendantCatalogueQuery
Description	Gets the query for a catalogue. Multiple retrievals produce a nested `OR` term.
Return	`osid.offering.CatalogueQuery`		the catalogue query
Errors	UNIMPLEMENTED		`supportsDescendantCatalogueQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDescendantCatalogueQuery()` is `true.`
Method	matchAnyDescendantCatalogue
Description	Matches catalogues with any descendant.
Parameters	`boolean`	`match`	`true` to match catalogues with any descendant, `false` to match leaf catalogues
Compliance	`mandatory`		This method must be implemented.
Method	clearDescendantCatalogueTerms
Description	Clears all descendant catalogue terms.
Compliance	`mandatory`		This method must be implemented.
Method	getCatalogueQueryRecord
Description	Gets the record query corresponding to the given `Catalogue` record `Type.` Multiple record retrievals produce a nested boolean `OR` term.
Parameters	`osid.type.Type`	`catalogueRecordType`	a catalogue record type
Return	`osid.offering.records.CatalogueQueryRecord`		the catalogue query record
Errors	NULL_ARGUMENT		`catalogueRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(catalogueRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.