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

Interface	osid.course.registration.request.RegistrationRequestQuery
Implements	`osid.OsidRequestQuery`
Used By	`osid.course.registration.request.RegistrationRequestItemQuery`
	`osid.course.registration.request.RegistrationRequestQuerySession`
	`osid.course.registration.request.RegistrationRequestSearchSession`
	`osid.course.registration.request.RegistrationRequestSmartCourseCatalogSession`
Description	This is the query for searching registration requests. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchTermId
Description	Sets the term `Id` for this query.
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	clearTermTerms
Description	Clears the term query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchCourseCatalogId
Description	Sets the course catalog `Id` for this query to match registration requests 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	getRegistrationRequestQueryRecord
Description	Gets the registration request query record corresponding to the given `RegistrationRequest` record `Type`. Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`registrationRequestRecordType`	a registration request record type
Return	`osid.course.registration.request.records.RegistrationRequestQueryRecord`		the registration request query record
Errors	NULL_ARGUMENT		`registrationRequestRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(registrationRequestRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.