OSID - osid.offering.rules.OfferingConstrainerQueryInspector Service Interface Definition

Interface	osid.offering.rules.OfferingConstrainerQueryInspector
Implements	`osid.OsidConstrainerQueryInspector`
Used By	`osid.offering.rules.CanonicalUnitEnablerQueryInspector`
	`osid.offering.rules.OfferingConstrainerEnablerQueryInspector`
	`osid.offering.rules.OfferingConstrainerSearchResults`
	`osid.offering.rules.OfferingConstrainerSmartCatalogueSession`
Description	This is the query inspector for examining offering constrainer queries. Like all `OsidQueryInspectors`, `OfferingConstrainerQueryInspector` is stateful and must not be accessed by multiple processing threads.
Method	getRuledCanonicalUnitIdTerms
Description	Gets the canonical unit `Id` query terms.
Return	`osid.search.terms.IdTerm[]`		the query terms
Compliance	`mandatory`		This method must be implemented.
Method	getRuledCanonicalUnitTerms
Description	Gets the canonical unit query terms.
Return	`osid.offering.CanonicalUnitQueryInspector[]`		the query terms
Compliance	`mandatory`		This method must be implemented.
Method	getOverrideDescriptionTerms
Description	Gets the override description query terms.
Return	`osid.search.terms.BooleanTerm[]`		the query terms
Compliance	`mandatory`		This method must be implemented.
Method	getOverrideTitleTerms
Description	Gets the override title query terms.
Return	`osid.search.terms.BooleanTerm[]`		the query terms
Compliance	`mandatory`		This method must be implemented.
Method	getOverrideCodeTerms
Description	Gets the override code query terms.
Return	`osid.search.terms.BooleanTerm[]`		the query terms
Compliance	`mandatory`		This method must be implemented.
Method	getOverrideTimePeriodsTerms
Description	Gets the override time periods query terms.
Return	`osid.search.terms.BooleanTerm[]`		the query terms
Compliance	`mandatory`		This method must be implemented.
Method	getConstrainTimePeriodsTerms
Description	Gets the override time periods query terms.
Return	`osid.search.terms.BooleanTerm[]`		the query terms
Compliance	`mandatory`		This method must be implemented.
Method	getOverrideResultOptionsTerms
Description	Gets the override result options query terms.
Return	`osid.search.terms.BooleanTerm[]`		the query terms
Compliance	`mandatory`		This method must be implemented.
Method	getConstrainResultOptionsTerms
Description	Gets the constrain result options query terms.
Return	`osid.search.terms.BooleanTerm[]`		the query terms
Compliance	`mandatory`		This method must be implemented.
Method	getOverrideSponsorsTerms
Description	Gets the override sponsors query terms.
Return	`osid.search.terms.BooleanTerm[]`		the query terms
Compliance	`mandatory`		This method must be implemented.
Method	getConstrainSponsorsTerms
Description	Gets the constrain sponsors query terms.
Return	`osid.search.terms.BooleanTerm[]`		the query terms
Compliance	`mandatory`		This method must be implemented.
Method	getCatalogueIdTerms
Description	Gets the catalogue `Id` query terms.
Return	`osid.search.terms.IdTerm[]`		the query terms
Compliance	`mandatory`		This method must be implemented.
Method	getCatalogueTerms
Description	Gets the catalogue query terms.
Return	`osid.offering.CatalogueQueryInspector[]`		the query terms
Compliance	`mandatory`		This method must be implemented.
Method	getOfferingConstrainerQueryInspectorRecord
Description	Gets the offering constrainer query inspector record corresponding to the given `OfferingConstrainer` record `Type`.
Parameters	`osid.type.Type`	`offeringConstrainerRecordType`	an offering constrainer record type
Return	`osid.offering.rules.records.OfferingConstrainerQueryInspectorRecord`		the offering constrainer query inspector record
Errors	NULL_ARGUMENT		`offeringConstrainerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(offeringConstrainerRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.