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

Interface	osid.course.registration.RegistrationTargetQuery
Implements	`osid.OsidObjectQuery`
Implements	`osid.OsidSubjugateableQuery`
Used By	`osid.course.registration.RegistrationQuery`
	`osid.course.registration.RegistrationTargetQuerySession`
	`osid.course.registration.RegistrationTargetSearchSession`
	`osid.course.registration.RegistrationTargetSmartCourseCatalogSession`
	`osid.course.registration.request.RegistrationRequestItemQuery`
Description	This is the query for searching registration targets. 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 `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`		a 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	matchActivityId
Description	Sets the activity `Id` for this query to match registration targets that have a related course.
Parameters	`osid.id.Id`	`activityId`	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` 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 registration targets that have any activity.
Parameters	`boolean`	`match`	`true` to match registration targets with any activity, `false` to match registration targets with no activities
Compliance	`mandatory`		This method must be implemented.
Method	clearActivityTerms
Description	Clears the activity terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchCredits
Description	Matches registration targets 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 target that has any credits assigned.
Parameters	`boolean`	`match`	`true` to match registration targets with any credits, `false` to match registration targets 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 registration targets that have any grading option.
Parameters	`boolean`	`match`	`true` to match registration targets with any grading option, `false` to match registration targets 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 registration targets 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	getRegistrationTargetQueryRecord
Description	Gets the registration target query record corresponding to the given `RegistrationTarget` record `Type` . Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`registrationTargetRecordType`	a registration target record type
Return	`osid.course.registration.records.RegistrationTargetQueryRecord`		the registration target query record
Errors	NULL_ARGUMENT		`registrationTargetRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(registrationTargetRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.