OSID - osid.course.chronicle.ProgramEntryQuery Service Interface Definition

Interface	osid.course.chronicle.ProgramEntryQuery
Implements	`osid.OsidRelationshipQuery`
Description	This is the query for searching program entries. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR.`
Method	matchStudentId
Description	Sets the student `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 `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsStudentQuery
Description	Tests if a `StudentQuery` is available.
Return	`boolean`		`true` if a student query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getStudentQuery
Description	Gets the query for a student option. Multiple retrievals produce a nested `OR` term.
Return	`osid.resource.ResourceQuery`		a student query
Errors	UNIMPLEMENTED		`supportsStudentQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsStudentQuery()` is `true.`
Method	clearStudentTerms
Description	Clears the student option terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchProgramId
Description	Sets the program `Id` for this query to match entries that have an entry for the given course.
Parameters	`osid.id.Id`	`programId`	a program `Id`
Parameters	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`programId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearProgramIdTerms
Description	Clears the program `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsProgramQuery
Description	Tests if a `ProgramQuery` is available.
Return	`boolean`		`true` if a program query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getProgramQuery
Description	Gets the query for a program entry. Multiple retrievals produce a nested `OR` term.
Return	`osid.course.program.ProgramQuery`		a program query
Errors	UNIMPLEMENTED		`supportsProgramQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsProgramQuery()` is `true.`
Method	clearProgramTerms
Description	Clears the program terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAdmissionDate
Description	Matches admission dates between the given dates inclusive.
Parameters	`osid.calendaring.DateTime`	`from`	starting date
	`osid.calendaring.DateTime`	`to`	ending date
	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`from` is greater than `to`
Errors	NULL_ARGUMENT		`from` or `to` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyAdmissionDate
Description	Matches entries that have any admission date.
Parameters	`boolean`	`match`	`true` to match entries with any admission date, `false` to match entries with no admission date
Compliance	`mandatory`		This method must be implemented.
Method	clearAdmissionDateTerms
Description	Clears the admission date terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchComplete
Description	Matches completed programs.
Parameters	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Compliance	`mandatory`		This method must be implemented.
Method	clearCompleteTerms
Description	Clears the complete terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchTermId
Description	Sets the term `Id` for this query.
Parameters	`osid.id.Id`	`termId`	a term `Id`
Parameters	`boolean`	`match`	`true` if 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` 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 entry. Multiple retrievals produce a nested `OR` term.
Return	`osid.course.TermQuery`		a term query
Errors	UNIMPLEMENTED		`supportsTermQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsTermQuery()` is `true.`
Method	matchAnyTerm
Description	Matches entries that have any term.
Parameters	`boolean`	`match`	`true` to match entries specific to a term, `false` to match entries for the entire enrollment
Compliance	`mandatory`		This method must be implemented.
Method	clearTermTerms
Description	Clears the term terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchCreditScaleId
Description	Matches a credit scale `Id.`
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	clearCreditScaleIdTerms
Description	Clears the grade system `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsCreditScaleQuery
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	getCreditScaleQuery
Description	Gets the query for a grade system. Multiple retrievals produce a nested `OR` term.
Return	`osid.grading.GradeSystemQuery`		a grade system query
Errors	UNIMPLEMENTED		`supportsCreditScaleQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCreditScaleQuery()` is `true.`
Method	matchAnyCreditScale
Description	Matches entries that have any credit scale.
Parameters	`boolean`	`match`	`true` to match entries with any credit scale, `false` to match entries with no credit scale
Compliance	`mandatory`		This method must be implemented.
Method	clearCreditScaleTerms
Description	Clears the credit scale terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchCreditsEarned
Description	Matches earned credits between the given range inclusive.
Parameters	`decimal`	`from`	starting value
	`decimal`	`to`	ending value
	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`from` is greater than `to`
Errors	NULL_ARGUMENT		`from` or `to` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyCreditsEarned
Description	Matches entries that have any earned credits.
Parameters	`boolean`	`match`	`true` to match entries with any earned credits, `false` to match entries with no earned credits
Compliance	`mandatory`		This method must be implemented.
Method	clearCreditsEarnedTerms
Description	Clears the earned credits terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchGPAScaleId
Description	Matches a GPA scale `Id.`
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	clearGPAScaleIdTerms
Description	Clears the grade system `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsGPAScaleQuery
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	getGPAScaleQuery
Description	Gets the query for a grade system. Multiple retrievals produce a nested `OR` term.
Return	`osid.grading.GradeSystemQuery`		a grade system query
Errors	UNIMPLEMENTED		`supportsGPAScaleQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsGPAScaleQuery()` is `true.`
Method	matchAnyGPAScale
Description	Matches entries that have any GPA scale.
Parameters	`boolean`	`match`	`true` to match entries with any GPA scale, `false` to match entries with no GPA scale
Compliance	`mandatory`		This method must be implemented.
Method	clearGPAScaleTerms
Description	Clears the credit scale terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchGPA
Description	Matches GPA between the given range inclusive.
Parameters	`decimal`	`from`	starting value
	`decimal`	`to`	ending value
	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`from` is greater than `to`
Errors	NULL_ARGUMENT		`from` or `to` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyGPA
Description	Matches entries that have any GPA.
Parameters	`boolean`	`match`	`true` to match entries with any GPA, `false` to match entries with no GPA
Compliance	`mandatory`		This method must be implemented.
Method	clearGPATerms
Description	Clears the GPA terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchEnrollmentId
Description	Sets the enrollment `Id` for this query.
Parameters	`osid.id.Id`	`enrollmentId`	an enrollment `Id`
Parameters	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`enrollmentId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearEnrollmentIdTerms
Description	Clears the enrollment `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsEnrollmentQuery
Description	Tests if an `EnrollmentQuery` is available.
Return	`boolean`		`true` if an enrollment query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getEnrollmentQuery
Description	Gets the query for an enrollment entry. Multiple retrievals produce a nested `OR` term.
Return	`osid.course.program.EnrollmentQuery`		an enrollment query
Errors	UNIMPLEMENTED		`supportsEnrollmentQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsEnrollmentQuery()` is `true.`
Method	matchAnyEnrollment
Description	Matches entries that have any enrollment.
Parameters	`boolean`	`match`	`true` to match enries with any enrollment, `false` to match enries with no enrollments
Compliance	`mandatory`		This method must be implemented.
Method	clearEnrollmentTerms
Description	Clears the enrollment terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchCourseCatalogId
Description	Sets the course catalog `Id` for this query to match entries 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	getProgramEntryQueryRecord
Description	Gets the program entry query record corresponding to the given `ProgramEntry` record `Type.` Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`programEntryRecordType`	a program entry record type
Return	`osid.course.chronicle.records.ProgramEntryQueryRecord`		the program entry query record
Errors	NULL_ARGUMENT		`programEntryRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(programEntryRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.