OSID - osid.course.CourseQuery Service Interface Definition

Interface	osid.course.CourseQuery
Implements	`osid.OsidObjectQuery`
Implements	`osid.OsidOperableQuery`
Description	This is the query for searching courses. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR.`
Method	matchTitle
Description	Adds a title for this query.
Parameters	`string`	`title`	title string to match
	`osid.type.Type`	`stringMatchType`	the string match type
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`title` 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 a title that has any value.
Parameters	`boolean`	`match`	`true` to match courses with any title, `false` to match courses with no title
Compliance	`mandatory`		This method must be implemented.
Method	clearTitleTerms
Description	Clears the title terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchNumber
Description	Adds a course number for this query.
Parameters	`string`	`number`	course number string to match
	`osid.type.Type`	`stringMatchType`	the string match type
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`number` not of `stringMatchType`
	NULL_ARGUMENT		`number` or `stringMatchType` is `null`
	UNSUPPORTED		`supportsStringMatchType(stringMatchType)` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyNumber
Description	Matches a course number that has any value.
Parameters	`boolean`	`match`	`true` to match courses with any number, `false` to match courses with no title
Compliance	`mandatory`		This method must be implemented.
Method	clearNumberTerms
Description	Clears the number terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchSponsorId
Description	Sets the resource `Id` for this query to match courses 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 courses that have any sponsor.
Parameters	`boolean`	`match`	`true` to match courses with any sponsor, `false` to match courses 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	matchCreditAmountId
Description	Sets the grade `Id` for this query to match courses with a credit amount.
Parameters	`osid.id.Id`	`gradeId`	a grade `Id`
Parameters	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`gradeId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearCreditAmountIdTerms
Description	Clears the grade system `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsCreditAmountQuery
Description	Tests if a `GradeQuery` is available.
Return	`boolean`		`true` if a grade system query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCreditAmountQuery
Description	Gets the query for a credit amount. Multiple retrievals produce a nested `OR` term.
Return	`osid.grading.GradeQuery`		a grade query
Errors	UNIMPLEMENTED		`supportsCreditQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCreditQuery()` is `true.`
Method	matchAnyCreditAmount
Description	Matches courses that have any credits.
Parameters	`boolean`	`match`	`true` to match courses with any credits `false` to match courses with no credits
Compliance	`mandatory`		This method must be implemented.
Method	clearCreditAmountTerms
Description	Clears the credit terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchPrerequisitesInfo
Description	Matches courses with the prerequisites informational string.
Parameters	`string`	`prereqInfo`	prerequisite informational string to match
	`osid.type.Type`	`stringMatchType`	the string match type
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`prereqInfo` not of `stringMatchType`
	NULL_ARGUMENT		`prereqInfo` or `stringMatchType` is `null`
	UNSUPPORTED		`supportsStringMatchType(stringMatchType)` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyPrerequisitesInfo
Description	Matches a course that has any prerequisite information assigned.
Parameters	`boolean`	`match`	`true` to match courses with any prerequisite information, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	clearPrerequisitesInfoTerms
Description	Clears the prerequisite info terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchPrerequisitesId
Description	Sets the requisite `Id` for this query.
Parameters	`osid.id.Id`	`requisiteId`	a requisite `Id`
Parameters	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`requisiteId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearPrerequisitesIdTerms
Description	Clears the requisite `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsPrerequisitesQuery
Description	Tests if a `RequisiteQuery` is available.
Return	`boolean`		`true` if a requisite query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getPrerequisitesQuery
Description	Gets the query for a requisite. Multiple retrievals produce a nested `OR` term.
Return	`osid.course.requisite.RequisiteQuery`		a prerequisites query
Errors	UNIMPLEMENTED		`supportsPrerequisitesQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPrerequisitesQuery()` is `true.`
Method	matchAnyPrerequisites
Description	Matches courses that have any prerequisites.
Parameters	`boolean`	`match`	`true` to match courses with any prerequisites, `false` to match courses with no prerequisites
Compliance	`mandatory`		This method must be implemented.
Method	clearPrerequisitesTerms
Description	Clears the prerequisites terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchLevelId
Description	Sets the grade `Id` for this query.
Parameters	`osid.id.Id`	`gradeId`	a grade `Id`
Parameters	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`gradeId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearLevelIdTerms
Description	Clears the grade `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsLevelQuery
Description	Tests if a `GradeQuery` is available.
Return	`boolean`		`true` if a grade query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getLevelQuery
Description	Gets the query for a grade level. Multiple retrievals produce a nested `OR` term.
Return	`osid.grading.GradeQuery`		a grade query
Errors	UNIMPLEMENTED		`supportsLevelQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsLevelQuery()` is `true.`
Method	matchAnyLevel
Description	Matches courses that have any grade level.
Parameters	`boolean`	`match`	`true` to match courses with any level, `false` to match courses with no level
Compliance	`mandatory`		This method must be implemented.
Method	clearLevelTerms
Description	Clears the level terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchGradingOptionId
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	clearGradingOptionIdTerms
Description	Clears the grade system `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsGradingOptionQuery
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	getGradingOptionQuery
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		`supportsGradingOptionQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsGradingOptionQuery()` is `true.`
Method	matchAnyGradingOption
Description	Matches courses that have any grading option.
Parameters	`boolean`	`match`	`true` to match courses with any grading option, `false` to match courses with no grading options
Compliance	`mandatory`		This method must be implemented.
Method	clearGradingOptionTerms
Description	Clears the grading option terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchLearningObjectiveId
Description	Sets the objective `Id` for this query.
Parameters	`osid.id.Id`	`objectiveId`	an objective `Id`
Parameters	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`objectiveId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearLearningObjectiveIdTerms
Description	Clears the objective `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsLearningObjectiveQuery
Description	Tests if a `ObjectiveQuery` is available.
Return	`boolean`		`true` if an objective query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getLearningObjectiveQuery
Description	Gets the query for a learning objective. Multiple retrievals produce a nested `OR` term.
Return	`osid.learning.ObjectiveQuery`		an objective query
Errors	UNIMPLEMENTED		`supportsLearningObjectiveQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsLearningObjectiveQuery()` is `true.`
Method	matchAnyLearningObjective
Description	Matches courses that have any learning objective.
Parameters	`boolean`	`match`	`true` to match courses with any learning objective, `false` to match courses with no learning objectives
Compliance	`mandatory`		This method must be implemented.
Method	clearLearningObjectiveTerms
Description	Clears the learning objective terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchActivityUnitId
Description	Sets the course offering `Id` for this query to match courses that have a related course offering.
Parameters	`osid.id.Id`	`courseOfferingId`	a course offering `Id`
Parameters	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`courseOfferingId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearActivityUnitIdTerms
Description	Clears the activity unit `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsActivityUnitQuery
Description	Tests if a `ActivityUnitQuery` is available.
Return	`boolean`		`true` if a activity unit query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getActivityUnitQuery
Description	Gets the query for an activity unit. Multiple retrievals produce a nested `OR` term.
Return	`osid.course.ActivityUnitQuery`		the activity unit query
Errors	UNIMPLEMENTED		`supportsActivityUnitQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsActivityUnitQuery()` is `true.`
Method	matchAnyActivityUnit
Description	Matches courses that have any course offering.
Parameters	`boolean`	`match`	`true` to match courses with any related activity unit, `false` to match courses with no activity units
Compliance	`mandatory`		This method must be implemented.
Method	clearActivityUnitTerms
Description	Clears the activity unit terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchCourseOfferingId
Description	Sets the course offering `Id` for this query to match courses that have a related course offering.
Parameters	`osid.id.Id`	`courseOfferingId`	a course offering `Id`
Parameters	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`courseOfferingId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearCourseOfferingIdTerms
Description	Clears the course offering `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsCourseOfferingQuery
Description	Tests if a `CourseOfferingQuery` is available.
Return	`boolean`		`true` if a course offering query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCourseOfferingQuery
Description	Gets the query for a course offering. Multiple retrievals produce a nested `OR` term.
Return	`osid.course.CourseOfferingQuery`		the course offering query
Errors	UNIMPLEMENTED		`supportsCourseOfferingQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCourseOfferingQuery()` is `true.`
Method	matchAnyCourseOffering
Description	Matches courses that have any course offering.
Parameters	`boolean`	`match`	`true` to match courses with any course offering, `false` to match courses with no course offering
Compliance	`mandatory`		This method must be implemented.
Method	clearCourseOfferingTerms
Description	Clears the course offering terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchCourseCatalogId
Description	Sets the course catalog `Id` for this query to match courses assigned to course catalogs.
Parameters	`osid.id.Id`	`courseCatalogId`	the course catalog `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`courseCatalogId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearCourseCatalogIdTerms
Description	Clears the course catalog `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsCourseCatalogQuery
Description	Tests if a `CourseCatalogQuery` is available.
Return	`boolean`		`true` if a course catalog query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCourseCatalogQuery
Description	Gets the query for a course catalog. Multiple retrievals produce a nested `OR` term.
Return	`osid.course.CourseCatalogQuery`		the course catalog query
Errors	UNIMPLEMENTED		`supportsCourseCatalogQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCourseCatalogQuery()` is `true.`
Method	clearCourseCatalogTerms
Description	Clears the course catalog terms.
Compliance	`mandatory`		This method must be implemented.
Method	getCourseQueryRecord
Description	Gets the course query record corresponding to the given `Course` record `Type.` Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`courseRecordType`	a course record type
Return	`osid.course.records.CourseQueryRecord`		the course query record
Errors	NULL_ARGUMENT		`courseRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(courseRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.