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

Interface	osid.course.registration.RegistrationQuery
Implements	`osid.OsidRelationshipQuery`
Used By	`osid.course.chronicle.CourseEntryQuery`
	`osid.course.registration.RegistrationQuerySession`
	`osid.course.registration.RegistrationSearchSession`
	`osid.course.registration.RegistrationSmartCourseCatalogSession`
	`osid.course.registration.request.RegistrationRequestItemQuery`
Description	This is the query for searching registrations. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchCourseRegistrationId
Description	Sets the course registration `Id` for this query.
Parameters	`osid.id.Id`	`courseRegistrationId`	a course registration `Id`
Parameters	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`courseRegistrationId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearCourseRegistrationIdTerms
Description	Clears the course registration `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsCourseRegistrationQuery
Description	Tests if a `CourseRegistrationQuery` is available.
Return	`boolean`		`true` if a course registration query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCourseRegistrationQuery
Description	Gets the query for a course registration. Multiple retrievals produce a nested `OR` term.
Return	`osid.course.registration.CourseRegistrationQuery`		the course registration query
Errors	UNIMPLEMENTED		`supportsCourseRegistrationQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCourseRegistrationQuery()` is `true`.
Method	clearCourseRegistrationTerms
Description	Clears the course registration terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchRegistrationTargetId
Description	Sets the registration target `Id` for this query.
Parameters	`osid.id.Id`	`registrationTargetId`	a registration target `Id`
Parameters	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`registrationTargetId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearRegistrationTargetIdTerms
Description	Clears the registration target `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsRegistrationTargetQuery
Description	Tests if a `RegistrationTargetQuery` is available.
Return	`boolean`		`true` if a registration target query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRegistrationTargetQuery
Description	Gets the query for a registration target. Multiple retrievals produce a nested `OR` term.
Return	`osid.course.registration.RegistrationTargetQuery`		the registration target query
Errors	UNIMPLEMENTED		`supportsRegistrationTargetQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRegistrationTargetQuery()` is `true`.
Method	clearRegistrationTargetTerms
Description	Clears the registration target 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	matchCredits
Description	Matches registrations with credits between the given numbers inclusive.
Parameters	`decimal`	`min`	low number
	`decimal`	`max`	high number
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`max` is less than `min`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyCredits
Description	Matches a registration that has any credits assigned.
Parameters	`boolean`	`match`	`true` to match registrations with any credits, `false` to match registrations with no credits
Compliance	`mandatory`		This method must be implemented.
Method	clearCreditsTerms
Description	Clears the credit 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 registrations that have any grading option.
Parameters	`boolean`	`match`	`true` to match registrations with any grading option, `false` to match registrations 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	matchCourseCatalogId
Description	Sets the course catalog `Id` for this query to match 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` 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	getRegistrationQueryRecord
Description	Gets the registration query record corresponding to the given `Registration` record `Type`. Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`registrationRecordType`	a registration record type
Return	`osid.course.registration.records.RegistrationQueryRecord`		the registration query record
Errors	NULL_ARGUMENT		`registrationRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(registrationRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.