OSID - osid.offering.CatalogueQueryInspector Service Interface Definition

Interface	osid.offering.CatalogueQueryInspector
Implements	`osid.OsidCatalogQueryInspector`
Used By	`osid.offering.CanonicalUnitQueryInspector`
	`osid.offering.CatalogueQueryInspector`
	`osid.offering.CatalogueSearchResults`
	`osid.offering.OfferingQueryInspector`
	`osid.offering.ParticipantQueryInspector`
	`osid.offering.ResultQueryInspector`
	`osid.offering.rules.CanonicalUnitEnablerQueryInspector`
	`osid.offering.rules.CanonicalUnitProcessorEnablerQueryInspector`
	`osid.offering.rules.CanonicalUnitProcessorQueryInspector`
	`osid.offering.rules.OfferingConstrainerEnablerQueryInspector`
	show 1 more…
`osid.offering.rules.OfferingConstrainerQueryInspector`
Description	The query inspectors provide a means of accessing the match terms of a query. These interfaces are used to examine the actual query terms used in a search or that may be used to create a smart catalog. Query inspectors may be converted to `OsidQuery` interfaces for reuse or modification in the search sessions. Like all `OsidQueryInspectors`, `CatalogueQueryInspector` is stateful and must not be accessed by multiple processing threads.
Method	getCanonicalUnitIdTerms
Description	Gets the canonical unit `Id` query terms.
Return	`osid.search.terms.IdTerm[]`		the canonical unit `Id` terms
Compliance	`mandatory`		This method must be implemented.
Method	getCanonicalUnitTerms
Description	Gets the canonical unit query terms.
Return	`osid.offering.CanonicalUnitQueryInspector[]`		the canonical unit terms
Compliance	`mandatory`		This method must be implemented.
Method	getOfferingIdTerms
Description	Gets the offering `Id` query terms.
Return	`osid.search.terms.IdTerm[]`		the offering `Id` terms
Compliance	`mandatory`		This method must be implemented.
Method	getOfferingTerms
Description	Gets the offering query terms.
Return	`osid.offering.OfferingQueryInspector[]`		the offering terms
Compliance	`mandatory`		This method must be implemented.
Method	getParticipantIdTerms
Description	Gets the participant `Id` query terms.
Return	`osid.search.terms.IdTerm[]`		the participant `Id` terms
Compliance	`mandatory`		This method must be implemented.
Method	getParticipantTerms
Description	Gets the participant query terms.
Return	`osid.offering.ParticipantQueryInspector[]`		the participant terms
Compliance	`mandatory`		This method must be implemented.
Method	getResultIdTerms
Description	Gets the result `Id` query terms.
Return	`osid.search.terms.IdTerm[]`		the result `Id` terms
Compliance	`mandatory`		This method must be implemented.
Method	getResultTerms
Description	Gets the result query terms.
Return	`osid.offering.ResultQueryInspector[]`		the result terms
Compliance	`mandatory`		This method must be implemented.
Method	getAncestorCatalogueIdTerms
Description	Gets the ancestor catalogue `Id` query terms.
Return	`osid.search.terms.IdTerm[]`		the ancestor catalogue `Id` terms
Compliance	`mandatory`		This method must be implemented.
Method	getAncestorCatalogueTerms
Description	Gets the ancestor catalogue query terms.
Return	`osid.offering.CatalogueQueryInspector[]`		the ancestor catalogue terms
Compliance	`mandatory`		This method must be implemented.
Method	getDescendantCatalogueIdTerms
Description	Gets the descendant catalogue `Id` query terms.
Return	`osid.search.terms.IdTerm[]`		the descendant catalogue `Id` terms
Compliance	`mandatory`		This method must be implemented.
Method	getDescendantCatalogueTerms
Description	Gets the descendant catalogue query terms.
Return	`osid.offering.CatalogueQueryInspector[]`		the descendant catalogue terms
Compliance	`mandatory`		This method must be implemented.
Method	getCatalogueQueryInspectorRecord
Description	Gets the record query inspector record corresponding to the given `Catalogue` record `Type`.
Parameters	`osid.type.Type`	`catalogueRecordType`	a catalogue record type
Return	`osid.offering.records.CatalogueQueryInspectorRecord`		the catalogue query inspector 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.