OSID - osid.offering.CanonicalUnitQuery Service Interface Definition

Interface	osid.offering.CanonicalUnitQuery
Implements	`osid.OsidObjectQuery`
Implements	`osid.OsidOperableQuery`
Used By	`osid.offering.CanonicalUnitQuerySession`
	`osid.offering.CanonicalUnitSearchSession`
	`osid.offering.CanonicalUnitSmartCatalogueSession`
	`osid.offering.CatalogueQuery`
	`osid.offering.OfferingQuery`
	`osid.offering.rules.CanonicalUnitProcessorQuery`
	`osid.offering.rules.OfferingConstrainerQuery`
Description	This is the query for searching canonical units. Each method specifies an `AND` term while multiple invocations of the same method produce a nested `OR` .
Method	matchTitle
Description	Matches a title.
Parameters	`string`	`title`	a title
	`osid.type.Type`	`stringMatchType`	a string match type
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`title` is not of `stringMatchType`
	NULL_ARGUMENT		`title` or `stringMatchType` is `null`
	UNSUPPORTED		`supportsStringMatchType(stringMatchType)` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyTitle
Description	Matches canonical units with any title.
Parameters	`boolean`	`match`	`true` to match canonical units with any title, `false` to match canonical units with no title
Compliance	`mandatory`		This method must be implemented.
Method	clearTitleTerms
Description	Clears all title terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchCode
Description	Matches a code.
Parameters	`string`	`code`	a code
	`osid.type.Type`	`stringMatchType`	a string match type
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`code` is not of `stringMatchType`
	NULL_ARGUMENT		`code` or `stringMatchType` is `null`
	UNSUPPORTED		`supportsStringMatchType(stringMatchType)` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyCode
Description	Matches canonical units with any code.
Parameters	`boolean`	`match`	`true` to match canonical units with any code, `false` to match canonical units with no code
Compliance	`mandatory`		This method must be implemented.
Method	clearCodeTerms
Description	Clears all code terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchOfferedCyclicTimePeriodId
Description	Sets the cyclic time period `Id` for this query.
Parameters	`osid.id.Id`	`cyclicTimePeriodId`	a cyclic time period `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`cyclicTimePeriodId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearOfferedCyclicTimePeriodIdTerms
Description	Clears all offered cyclic time period `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsOfferedCyclicTimePeriodQuery
Description	Tests if a `CyclicTimePeriodQuery` is available.
Return	`boolean`		`true` if a cyclic time period query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getOfferedCyclicTimePeriodQuery
Description	Gets the query for a cyclic period query. Multiple retrievals produce a nested `OR` term.
Return	`osid.calendaring.cycle.CyclicTimePeriodQuery`		the cyclic time period query
Errors	UNIMPLEMENTED		`supportsOfferedCyclicTimePeriodQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsOfferedCyclicTimePeriodQuery()` is `true` .
Method	matchAnyOfferedCyclicTimePeriod
Description	Matches canonicals that have any cyclic time period.
Parameters	`boolean`	`match`	`true` to match canonicals with any cyclic time period, `false` to match canonicals with no cyclic time periods
Compliance	`mandatory`		This method must be implemented.
Method	clearOfferedCyclicTimePeriodTerms
Description	Clears all cyclic time period terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchResultOptionId
Description	Sets the grade system `Id` for this query.
Parameters	`osid.id.Id`	`gradeSystemId`	a grade system `Id`
Parameters	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`gradeSystemId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearResultOptionIdTerms
Description	Clears the grade system `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsResultOptionQuery
Description	Tests if a `GradeSystemQuery` is available.
Return	`boolean`		`true` if a grade system query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getResultOptionQuery
Description	Gets the query for a grading option. Multiple retrievals produce a nested `OR` term.
Return	`osid.grading.GradeSystemQuery`		a grade system query
Errors	UNIMPLEMENTED		`supportsResultOptionQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsGradingOptionQuery()` is `true` .
Method	matchAnyResultOption
Description	Matches canonicals that have any grading option.
Parameters	`boolean`	`match`	`true` to match canonicals with any grading option, `false` to match canonicals with no grading options
Compliance	`mandatory`		This method must be implemented.
Method	clearResultOptionTerms
Description	Clears the grading option terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchSponsorId
Description	Sets the resource `Id` for this query to match canonicals that have a sponsor.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
Parameters	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`resourceId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearSponsorIdTerms
Description	Clears the sponsor `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsSponsorQuery
Description	Tests if a `ResourceQuery` is available.
Return	`boolean`		`true` if a resource query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getSponsorQuery
Description	Gets the query for a sponsor. Multiple retrievals produce a nested `OR` term.
Return	`osid.resource.ResourceQuery`		a resource query
Errors	UNIMPLEMENTED		`supportsSponsorQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsSponsorQuery()` is `true` .
Method	matchAnySponsor
Description	Matches canonicals that have any sponsor.
Parameters	`boolean`	`match`	`true` to match canonicals with any sponsor, `false` to match canonicals with no sponsors
Compliance	`mandatory`		This method must be implemented.
Method	clearSponsorTerms
Description	Clears the sponsor terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchCatalogueId
Description	Sets the catalogue `Id` for this query to match canonical units assigned to catalogues.
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	clearCatalogueIdTerms
Description	Clears all catalogue `Id` 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 query. 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 all catalogue terms.
Compliance	`mandatory`		This method must be implemented.
Method	getCanonicalUnitQueryRecord
Description	Gets the canonical unit query record corresponding to the given `CanonicalUnit` record `Type` . Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`canonicalUnitRecordType`	a canonical unit record type
Return	`osid.offering.records.CanonicalUnitQueryRecord`		the canonical unit query record
Errors	NULL_ARGUMENT		`canonicalUnitRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(canonicalUnitRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.