OSID - osid.course.registration.CourseRegistrationQuery Service Interface Definition

Interface	osid.course.registration.CourseRegistrationQuery
Implements	`osid.OsidRelationshipQuery`
Implements	`osid.OsidSubjugateableQuery`
Used By	`osid.course.registration.ActivityRegistrationQuery`
	`osid.course.registration.CourseRegistrationQuerySession`
	`osid.course.registration.CourseRegistrationSearchSession`
	`osid.course.registration.CourseRegistrationSmartCourseCatalogSession`
	`osid.course.registration.RegistrationQuery`
Description	This is the query for searching course registrations. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchCourseOfferingId
Description	Sets the course offering `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` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsCourseOfferingQuery
Description	Tests if a `CourseOffering` 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	clearCourseOfferingTerms
Description	Clears the course offering terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchStudentId
Description	Sets the student resource `Id` for this query.
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	clearStudentIdTerms
Description	Clears the student resource `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsStudentQuery
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	getStudentQuery
Description	Gets the query for a student. Multiple retrievals produce a nested `OR` term.
Return	`osid.resource.ResourceQuery`		the resource query
Errors	UNIMPLEMENTED		`supportsStudentQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsStudentQuery()` is `true`.
Method	clearStudentTerms
Description	Clears the student resource terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchCourseCatalogId
Description	Sets the course catalog `Id` for this query to match course registrations 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` query 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 query terms.
Compliance	`mandatory`		This method must be implemented.
Method	getCourseRegistrationQueryRecord
Description	Gets the course registration query record corresponding to the given `CourseRegistration` record `Type`. Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`courseRegistrationRecordType`	a course registration record type
Return	`osid.course.registration.records.CourseRegistrationQueryRecord`		the course registration query record
Errors	NULL_ARGUMENT		`courseRegistrationRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(courseRegistrationRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.