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

Interface	osid.offering.rules.OfferingConstrainerQuery
Implements	`osid.OsidConstrainerQuery`
Used By	`osid.offering.rules.CanonicalUnitEnablerQuery`
	`osid.offering.rules.OfferingConstrainerEnablerQuery`
	`osid.offering.rules.OfferingConstrainerQuerySession`
	`osid.offering.rules.OfferingConstrainerSearchSession`
	`osid.offering.rules.OfferingConstrainerSmartCatalogueSession`
Description	This is the query for searching offering constrainers. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchRuledCanonicalUnitId
Description	Matches mapped to the canonical unit.
Parameters	`osid.id.Id`	`canonicalUnitId`	the 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	clearRuledCanonicalUnitIdTerms
Description	Clears the canonical unit `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsRuledCanonicalUnitQuery
Description	Tests if an `CanonicalUnitQuery` is available.
Return	`boolean`		`true` if a canonical unit query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRuledCanonicalUnitQuery
Description	Gets the query for a canonical unit. Multiple retrievals produce a nested `OR` term.
Return	`osid.offering.CanonicalUnitQuery`		the canonical unit query
Errors	UNIMPLEMENTED		`supportsRuledCanonicalUnitQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRuledCanonicalUnitQuery()` is `true`.
Method	matchAnyRuledCanonicalUnit
Description	Matches rules mapped to any canonical unit.
Parameters	`boolean`	`match`	`true` for mapped to any canonical unit, `false` to match mapped to no canonicalUnit
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledCanonicalUnitTerms
Description	Clears the canonical unit query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchOverrideDescription
Description	Matches description overrides.
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyOverrideDescription
Description	Matches any description override.
Parameters	`boolean`	`match`	`true` for any description override, `false` to match no description override
Compliance	`mandatory`		This method must be implemented.
Method	clearOverrideDescriptionTerms
Description	Clears the description override query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchOverrideTitle
Description	Matches title overrides.
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyOverrideTitle
Description	Matches any title override.
Parameters	`boolean`	`match`	`true` for any title override, `false` to match no title override
Compliance	`mandatory`		This method must be implemented.
Method	clearOverrideTitleTerms
Description	Clears the title override query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchOverrideCode
Description	Matches code overrides.
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyOverrideCode
Description	Matches any code override.
Parameters	`boolean`	`match`	`true` for any code override, `false` to match no code override
Compliance	`mandatory`		This method must be implemented.
Method	clearOverrideCodeTerms
Description	Clears the code override query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchOverrideTimePeriods
Description	Matches time periods overrides.
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyOverrideTimePeriods
Description	Matches any time periods override.
Parameters	`boolean`	`match`	`true` for any time periods override, `false` to match no time periods override
Compliance	`mandatory`		This method must be implemented.
Method	clearOverrideTimePeriodsTerms
Description	Clears the time periods override query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchConstrainTimePeriods
Description	Matches constrain time periods.
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyConstrainTimePeriods
Description	Matches any constrain time periods.
Parameters	`boolean`	`match`	`true` for any time periods constraints, `false` to match no time periods constraints
Compliance	`mandatory`		This method must be implemented.
Method	clearConstrainTimePeriodsTerms
Description	Clears the constrain time periods query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchOverrideResultOptions
Description	Matches result options overrides.
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyOverrideResultOptions
Description	Matches any result options override.
Parameters	`boolean`	`match`	`true` for any result options override, `false` to match no result options override
Compliance	`mandatory`		This method must be implemented.
Method	clearOverrideResultOptionsTerms
Description	Clears the result options override query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchConstrainResultOptions
Description	Matches constrain result options.
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyConstrainResultOptions
Description	Matches any constrain result options.
Parameters	`boolean`	`match`	`true` for any result options constraints, `false` to match no result options constraints
Compliance	`mandatory`		This method must be implemented.
Method	clearConstrainResultOptionsTerms
Description	Clears the constrain result options query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchOverrideSponsors
Description	Matches result options overrides.
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyOverrideSponsors
Description	Matches any sponsors override.
Parameters	`boolean`	`match`	`true` for any sponsors override, `false` to match no sponsors override
Compliance	`mandatory`		This method must be implemented.
Method	clearOverrideSponsorsTerms
Description	Clears the sponsors override query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchConstrainSponsors
Description	Matches constrain sponsors.
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyConstrainSponsors
Description	Matches any constrain sponsors.
Parameters	`boolean`	`match`	`true` for any sponsors constraints, `false` to match no sponsors constraints
Compliance	`mandatory`		This method must be implemented.
Method	clearConstrainSponsorsTerms
Description	Clears the constrain sponsors query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchCatalogueId
Description	Matches mapped to the catalogue.
Parameters	`osid.id.Id`	`catalogueId`	the 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	clearCatalogueIdTerms
Description	Clears the catalogue `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsCatalogueQuery
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	getCatalogueQuery
Description	Gets the query for a catalogue. Multiple retrievals produce a nested `OR` term.
Return	`osid.offering.CatalogueQuery`		the catalogue query
Errors	UNIMPLEMENTED		`supportsCatalogueQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCatalogueQuery()` is `true`.
Method	clearCatalogueTerms
Description	Clears the catalogue query terms.
Compliance	`mandatory`		This method must be implemented.
Method	getOfferingConstrainerQueryRecord
Description	Gets the offering constrainer query record corresponding to the given `OfferingConstrainer` record `Type`. Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`offeringConstrainerRecordType`	an offering constrainer record type
Return	`osid.offering.rules.records.OfferingConstrainerQueryRecord`		the offering constrainer query 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.