OSID - osid.course.CourseCatalogQuery Service Interface Definition

Interface	osid.course.CourseCatalogQuery
Implements	`osid.OsidCatalogQuery`
Description	This is the query for searching course catalogs. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR.`
Method	matchCourseId
Description	Sets the course `Id` for this query to match courses that have a related course.
Parameters	`osid.id.Id`	`courseId`	a course `Id`
Parameters	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`courseId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearCourseIdTerms
Description	Clears the course `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsCourseQuery
Description	Tests if a `CourseQuery` is available.
Return	`boolean`		`true` if a course query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCourseQuery
Description	Gets the query for a course. Multiple retrievals produce a nested `OR` term.
Return	`osid.course.CourseQuery`		the course query
Errors	UNIMPLEMENTED		`supportsCourseQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCourseQuery()` is `true.`
Method	matchAnyCourse
Description	Matches course catalogs that have any course.
Parameters	`boolean`	`match`	`true` to match courses with any course, `false` to match courses with no course
Compliance	`mandatory`		This method must be implemented.
Method	clearCourseTerms
Description	Clears the course query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchActivityUnitId
Description	Sets the activity unit `Id` for this query.
Parameters	`osid.id.Id`	`activityUnitId`	an activity unit `Id`
Parameters	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`activityUnitId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearActivityUnitIdTerms
Description	Clears the activity unit `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsActivityUnitQuery
Description	Tests if an `ActivityUnitQuery` is available.
Return	`boolean`		`true` if an 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 course catalogs that have any activity unit.
Parameters	`boolean`	`match`	`true` to match course catalogs with any activity unit, `false` to match course catalogs with no activity units
Compliance	`mandatory`		This method must be implemented.
Method	clearActivityUnitTerms
Description	Clears the activity unit query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchCourseOfferingId
Description	Sets the catalog `Id` for this query.
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` query 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 course catalogs 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 query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchActivityId
Description	Sets the activity `Id` for this query.
Parameters	`osid.id.Id`	`activityUnitId`	an activity `Id`
Parameters	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`activityId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearActivityIdTerms
Description	Clears the activity `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsActivityQuery
Description	Tests if an `ActivityQuery` is available.
Return	`boolean`		`true` if an activity query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getActivityQuery
Description	Gets the query for an activity. Multiple retrievals produce a nested `OR` term.
Return	`osid.course.ActivityQuery`		the activity query
Errors	UNIMPLEMENTED		`supportsActivityQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsActivityQuery()` is `true.`
Method	matchAnyActivity
Description	Matches course catalogs that have any activity.
Parameters	`boolean`	`match`	`true` to match course catalogs with any activity, `false` to match course catalogs with no activities
Compliance	`mandatory`		This method must be implemented.
Method	clearActivityTerms
Description	Clears the activity query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchTermId
Description	Sets the term `Id` for this query to match catalogs containing terms.
Parameters	`osid.id.Id`	`termId`	the term `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`termId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearTermIdTerms
Description	Clears the term `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsTermQuery
Description	Tests if a `TermQuery` is available.
Return	`boolean`		`true` if a term query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getTermQuery
Description	Gets the query for a term Multiple retrievals produce a nested `OR` term.
Return	`osid.course.TermQuery`		the term query
Errors	UNIMPLEMENTED		`supportsTermQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsTermQuery()` is `true.`
Method	matchAnyTerm
Description	Matches course catalogs that have any term.
Parameters	`boolean`	`match`	`true` to match course catalogs with any term, `false` to match courses with no term
Compliance	`mandatory`		This method must be implemented.
Method	clearTermTerms
Description	Clears the term query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAncestorCourseCatalogId
Description	Sets the course catalog `Id` for this query to match course catalogs that have the specified course catalog as an ancestor.
Parameters	`osid.id.Id`	`courseCatalogId`	a 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	clearAncestorCourseCatalogIdTerms
Description	Clears the ancestor course catalog `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAncestorCourseCatalogQuery
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	getAncestorCourseCatalogQuery
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		`supportsAncestorCourseCatalogQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAncestorCourseCatalogQuery()` is `true.`
Method	matchAnyAncestorCourseCatalog
Description	Matches course catalogs with any course catalog ancestor.
Parameters	`boolean`	`match`	`true` to match course catalogs with any ancestor, `false` to match root course catalogs
Compliance	`mandatory`		This method must be implemented.
Method	clearAncestorCourseCatalogTerms
Description	Clears the ancestor course catalog query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDescendantCourseCatalogId
Description	Sets the course catalog `Id` for this query to match course catalogs that have the specified course catalog as an descendant.
Parameters	`osid.id.Id`	`courseCatalogId`	a 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	clearDescendantCourseCatalogIdTerms
Description	Clears the descendant course catalog `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsDescendantCourseCatalogQuery
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	getDescendantCourseCatalogQuery
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		`supportsDescendantCourseCatalogQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDescendantCourseCatalogQuery()` is `true.`
Method	matchAnyDescendantCourseCatalog
Description	Matches course catalogs with any descendant course catalog.
Parameters	`boolean`	`match`	`true` to match course catalogs with any descendant, `false` to match leaf course catalogs
Compliance	`mandatory`		This method must be implemented.
Method	clearDescendantCourseCatalogTerms
Description	Clears the descendant course catalog query terms.
Compliance	`mandatory`		This method must be implemented.
Method	getCourseCatalogQueryRecord
Description	Gets the course catalog query record corresponding to the given `CourseCatalog` record `Type.` Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`courseCatalogRecordType`	a course catalog record type
Return	`osid.course.records.CourseCatalogQueryRecord`		the course catalog query record
Errors	NULL_ARGUMENT		`courseCatalogRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(courseCatalogRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.