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

Interface	osid.course.chronicle.AwardEntryQuery
Implements	`osid.OsidRelationshipQuery`
Used By	`osid.course.chronicle.AwardEntryQuerySession`
	`osid.course.chronicle.AwardEntrySearchSession`
	`osid.course.chronicle.AwardEntrySmartCourseCatalogSession`
Description	This is the query for searching award 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	matchAwardId
Description	Sets the award `Id` for this query to match entries that have an entry for the given course.
Parameters	`osid.id.Id`	`awardId`	an award `Id`
Parameters	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`awardId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAwardIdTerms
Description	Clears the award `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAwardQuery
Description	Tests if an `AwardQuery` is available.
Return	`boolean`		`true` if an award query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAwardQuery
Description	Gets the query for an award entry. Multiple retrievals produce a nested `OR` term.
Return	`osid.recognition.AwardQuery`		an award query
Errors	UNIMPLEMENTED		`supportsAwardQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAwardQuery()` is `true` .
Method	clearAwardTerms
Description	Clears the award terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDateAwarded
Description	Matches award 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	matchAnyDateAwarded
Description	Matches entries that have any award date.
Parameters	`boolean`	`match`	`true` to match entries with any award date, `false` to match entries with no award date
Compliance	`mandatory`		This method must be implemented.
Method	clearDateAwardedTerms
Description	Clears the award date terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchProgramId
Description	Sets the program `Id` for this query.
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. 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	matchAnyProgram
Description	Matches entries that have any program.
Parameters	`boolean`	`match`	`true` to match entries with any program `false` to match entries with no program
Compliance	`mandatory`		This method must be implemented.
Method	clearProgramTerms
Description	Clears the program terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchCourseId
Description	Sets the course `Id` for this query to match entries that have an entry for the given course.
Parameters	`osid.id.Id`	`courseId`	a course `Id`
Parameters	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`courseId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearCourseIdTerms
Description	Clears the course `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsCourseQuery
Description	Tests if a `CourseQuery` is available.
Return	`boolean`		`true` if a course query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCourseQuery
Description	Gets the query for a course entry. Multiple retrievals produce a nested `OR` term.
Return	`osid.course.CourseQuery`		a course query
Errors	UNIMPLEMENTED		`supportsCourseQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCourseQuery()` is `true` .
Method	matchAnyCourse
Description	Matches entries that have any course.
Parameters	`boolean`	`match`	`true` to match entries with any course, `false` to match entries with no course
Compliance	`mandatory`		This method must be implemented.
Method	clearCourseTerms
Description	Clears the course terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAssessmentId
Description	Sets the assessment `Id` for this query to match entries that have an entry for the given assessment,
Parameters	`osid.id.Id`	`assessmentId`	an assessment `Id`
Parameters	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`assessmentId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAssessmentIdTerms
Description	Clears the assessment `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAssessmentQuery
Description	Tests if an `AssessmentQuery` is available.
Return	`boolean`		`true` if an assessment query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAssessmentQuery
Description	Gets the query for an assessment entry. Multiple retrievals produce a nested `OR` term.
Return	`osid.assessment.AssessmentQuery`		an assessment query
Errors	UNIMPLEMENTED		`supportsAssessmentQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAssessmentQuery()` is `true` .
Method	matchAnyAssessment
Description	Matches entries that have any assessment.
Parameters	`boolean`	`match`	`true` to match entries with any assessment, `false` to match entries with no assessment
Compliance	`mandatory`		This method must be implemented.
Method	clearAssessmentTerms
Description	Clears the assessment 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	getAwardEntryQueryRecord
Description	Gets the award entry query record corresponding to the given `AwardEntry` record `Type` . Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`awardEntryRecordType`	an award entry record type
Return	`osid.course.chronicle.records.AwardEntryQueryRecord`		the award entry query record
Errors	NULL_ARGUMENT		`awardEntryRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(awardEntryRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.