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

Interface	osid.offering.rules.CanonicalUnitEnablerQuery
Implements	`osid.OsidEnablerQuery`
Used By	`osid.offering.rules.CanonicalUnitEnablerQuerySession`
	`osid.offering.rules.CanonicalUnitEnablerSearchSession`
	`osid.offering.rules.CanonicalUnitEnablerSmartCatalogueSession`
Description	This is the query for searching canonical unit enablers. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchRuledOfferingConstrainerId
Description	Matches enablers mapped to the offering constrainer.
Parameters	`osid.id.Id`	`offeringConstrainerId`	the offering constrainer `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`offeringConstrainerId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledOfferingConstrainerIdTerms
Description	Clears the offering constrainer `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsRuledOfferingConstrainerQuery
Description	Tests if an `OfferingConstrainerQuery` is available.
Return	`boolean`		`true` if an offering constrainer query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRuledOfferingConstrainerQuery
Description	Gets the query for an offering constrainer. Multiple retrievals produce a nested `OR` term.
Return	`osid.offering.rules.OfferingConstrainerQuery`		the offering constrainer query
Errors	UNIMPLEMENTED		`supportsRuledOfferingConstrainerQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRuledOfferingConstrainerQuery()` is `true`.
Method	matchAnyRuledOfferingConstrainer
Description	Matches enablers mapped to any offering constrainer.
Parameters	`boolean`	`match`	`true` for enablers mapped to any offering constrainer, `false` to match enablers mapped to no offering constrainers
Compliance	`mandatory`		This method must be implemented.
Method	clearRuledOfferingConstrainerTerms
Description	Clears the offering constrainer query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchCatalogueId
Description	Matches enablers 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	getCanonicalUnitEnablerQueryRecord
Description	Gets the canonical unit enabler query record corresponding to the given `CanonicalUnitEnabler` record `Type` . Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`canonicalUnitEnablerRecordType`	a canonical unit enabler record type
Return	`osid.offering.rules.records.CanonicalUnitEnablerQueryRecord`		the canonical unit enabler query record
Errors	NULL_ARGUMENT		`canonicalUnitEnablerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(canonicalUnitEnablerRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.