OSID - osid.course.program.EnrollmentQuery Service Interface Definition

Interface	osid.course.program.EnrollmentQuery
Implements	`osid.OsidRelationshipQuery`
Used By	`osid.course.chronicle.ProgramEntryQuery`
	`osid.course.program.EnrollmentQuery`
	`osid.course.program.EnrollmentQuerySession`
	`osid.course.program.EnrollmentSearchSession`
	`osid.course.program.EnrollmentSmartCourseCatalogSession`
Description	This is the query for searching enrollments. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchProgramOfferingId
Description	Sets the program offering `Id` for this query.
Parameters	`osid.id.Id`	`programOfferingId`	a program offering `Id`
Parameters	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`programOfferingId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearProgramOfferingIdTerms
Description	Clears the program offering `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsProgramOfferingQuery
Description	Tests if a `ProgramOffering` is available.
Return	`boolean`		`true` if a program offering query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getProgramOfferingQuery
Description	Gets the query for a program offering. Multiple retrievals produce a nested `OR` term.
Return	`osid.course.program.ProgramOfferingQuery`		the program offering query
Errors	UNIMPLEMENTED		`supportsProgramOfferingQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsProgramOfferingQuery()` is `true`.
Method	clearProgramOfferingTerms
Description	Clears the program 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	matchParentEnrollmentId
Description	Sets the parent enrollment `Id` for this query.
Parameters	`osid.id.Id`	`enrollmentId`	a parent enrollment `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`enrollmentId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearParentEnrollmentIdTerms
Description	Clears the parent enrollment `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsParentEnrollmentQuery
Description	Tests if a `EnrollmentQuery` is available.
Return	`boolean`		`true` if a parent enrollment query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getParentEnrollmentQuery
Description	Gets the query for a parent enrollment. Multiple retrievals produce a nested `OR` term.
Return	`osid.course.program.EnrollmentQuery`		the parent enrollment query
Errors	UNIMPLEMENTED		`supportsParentEnrollmentQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsParentEnrollmentQuery()` is `true`.
Method	matchAnyParentEnrollment
Description	Matches enrollments with any parent enrollment.
Parameters	`boolean`	`match`	`true` to match enrollments with any parent enrollment, `false` to match enrollments with no parent enrollment
Compliance	`mandatory`		This method must be implemented.
Method	clearParentEnrollmentTerms
Description	Clears the parent enrollment terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchCourseCatalogId
Description	Sets the course catalog `Id` for this query.
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	getEnrollmentQueryRecord
Description	Gets the enrollment query record corresponding to the given `Course` record `Type` .Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`enrollmentRecordType`	an enrollment record type
Return	`osid.course.program.records.EnrollmentQueryRecord`		the enrollment query record
Errors	NULL_ARGUMENT		`enrollmentRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(enrollmentRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.