OSID - osid.course.registration.request.RegistrationRequestItemQuery Service Interface Definition

Interface	osid.course.registration.request.RegistrationRequestItemQuery
Implements	`osid.OsidObjectQuery`
Implements	`osid.OsidSubjugateableQuery`
Used By	`osid.course.registration.request.RegistrationRequestItemQuerySession`
	`osid.course.registration.request.RegistrationRequestItemSearchSession`
	`osid.course.registration.request.RegistrationRequestItemSmartCourseCatalogSession`
Description	This is the query for searching registration request items. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchRegistrationRequestId
Description	Matches registration requests.
Parameters	`osid.id.Id`	`registrationRequestId`	the registration request `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`registrationRequestId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearRegistrationRequestIdTerms
Description	Clears the registration request `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsRegistrationRequestQuery
Description	Tests if a `RegistrationRequestQuery` is available.
Return	`boolean`		`true` if a registration request query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRegistrationRequestQuery
Description	Gets the query for a registration request. Multiple retrievals produce a nested `OR` term.
Return	`osid.course.registration.request.RegistrationRequestQuery`		the registration request query
Errors	UNIMPLEMENTED		`supportsRegistrationRequestQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRegistrationRequestQuery()` is `true`.
Method	clearRegistrationRequestTerms
Description	Clears the registration request query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchStudentId
Description	Matches students.
Parameters	`osid.id.Id`	`resourceId`	the resource `Id`
Parameters	`boolean`	`match`	`true` for 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` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsStudentQuery
Description	Tests if a `ResourceQuery` is available.
Return	`boolean`		`true` if a student resource query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getStudentQuery
Description	Gets the query for a resource. 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	matchAnyStudent
Description	Matches request items with any registration target.
Parameters	`boolean`	`match`	`true` to match request items with any student, `false` to match request items with no student
Compliance	`mandatory`		This method must be implemented.
Method	clearStudentTerms
Description	Clears the student query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchRegisterOperation
Description	Matches request items for registration.
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Compliance	`mandatory`		This method must be implemented.
Method	matchUpdateOperation
Description	Matches request items for updates.
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Compliance	`mandatory`		This method must be implemented.
Method	matchDropOperation
Description	Matches request items for drops.
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Compliance	`mandatory`		This method must be implemented.
Method	matchRegistrationTargetId
Description	Matches registration targets.
Parameters	`osid.id.Id`	`registrationTargetId`	the registration target `Id`
Parameters	`boolean`	`match`	`true` for 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` query 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	matchAnyRegistrationTarget
Description	Matches request items with any registration target.
Parameters	`boolean`	`match`	`true` to match request items with any registration target, `false` to match request items with no registration targets
Compliance	`mandatory`		This method must be implemented.
Method	clearRegistrationTargetTerms
Description	Clears the registration target query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchExistingRegistrationId
Description	Matches existing registrations.
Parameters	`osid.id.Id`	`existingRegistrationId`	the existing registration `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`existingRegistrationId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearExistingRegistrationIdTerms
Description	Clears the existing registration `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsExistingTargetQuery
Description	Tests if a `RegistrationQuery` is available.
Return	`boolean`		`true` if an existing registration query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getExistingRegistrationQuery
Description	Gets the query for an existing registration. Multiple retrievals produce a nested `OR` term.
Return	`osid.course.registration.RegistrationQuery`		the registration query
Errors	UNIMPLEMENTED		`supportsExistingRegistrationQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsExistingRegistrationQuery()` is `true`.
Method	matchAnyExistingRegistration
Description	Matches request items with any existing registration.
Parameters	`boolean`	`match`	`true` to match request items with any existing registration, `false` to match request items with no existing registrations
Compliance	`mandatory`		This method must be implemented.
Method	clearExistingRegistrationTerms
Description	Clears the existing registration query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchCreditOption
Description	Matches request items with a credit option in the given range inclusive.
Parameters	`decimal`	`from`	start of range
	`decimal`	`to`	end of range
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`from` is greater than `to`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyCreditOption
Description	Matches request items with any credit option.
Parameters	`boolean`	`match`	`true` to match request items with any existing credit option, `false` to match request items with no credit options
Compliance	`mandatory`		This method must be implemented.
Method	clearCreditOptionTerms
Description	Clears the credit option terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchGradingOptionId
Description	Matches grading options.
Parameters	`osid.id.Id`	`gradeSystemId`	thegrade systemn `Id`
Parameters	`boolean`	`match`	`true` for 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` query 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 grade system. Multiple retrievals produce a nested `OR` term.
Return	`osid.grading.GradeSystemQuery`		the grade system query
Errors	UNIMPLEMENTED		`supportsGradingOptionQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsGradingOptionQuery()` is `true`.
Method	matchAnyGradingOption
Description	Matches request items with any grading option.
Parameters	`boolean`	`match`	`true` to match request items with any grading option, `false` to match request items with no grading option
Compliance	`mandatory`		This method must be implemented.
Method	clearGradingOptionTerms
Description	Clears the grading option query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchCourseCatalogId
Description	Sets the course catalog `Id` for this query to match registration request items 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	getRegistrationRequestItemQueryRecord
Description	Gets the registration request item query record corresponding to the given `RegistrationRequestItem` record `Type`. Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`registrationRequestItemRecordType`	a registration request item record type
Return	`osid.course.registration.request.records.RegistrationRequestItemQueryRecord`		the registration request item query record
Errors	NULL_ARGUMENT		`registrationRequestItemRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(registrationRequestItemRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.