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

Interface	osid.course.chronicle.AwardEntry
Implements	`osid.OsidRelationship`
Used By	`osid.course.chronicle.AwardEntryAdminSession`
	`osid.course.chronicle.AwardEntryList`
	`osid.course.chronicle.AwardEntryLookupSession`
Description	An `AwardEntry` represents an academic record entry for a recognition.
Method	getStudentId
Description	Gets the `Id` of the `Student`.
Return	`osid.id.Id`		the student `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getStudent
Description	Gets the `Student`.
Return	`osid.resource.Resource`		the student
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getAwardId
Description	Gets the `Id` of the `Award`.
Return	`osid.id.Id`		the award `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getAward
Description	Gets the `Award`.
Return	`osid.recognition.Award`		the award
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getDateAwarded
Description	Gets the award date.
Return	`osid.calendaring.DateTime`		the date awarded
Compliance	`mandatory`		This method must be implemented.
Method	hasProgram
Description	Tests if this award applies to a specific program. If `hasProgram()` is `true`, `hasCourse()` and `hasAssessment()` must be false.
Return	`boolean`		`true` if a program is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getProgramId
Description	Gets the `Id` of the `Program`.
Return	`osid.id.Id`		the program `Id`
Errors	ILLEGAL_STATE		`hasProgram()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getProgram
Description	Gets the `Program`.
Return	`osid.course.program.Program`		the program
Errors	ILLEGAL_STATE		`hasProgram()` is `false`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	hasCourse
Description	Tests if this award applies to a specific course. If `hasCourse()` is `true`, `hasProgram()` and `hasAssessment()` must be `false`.
Return	`boolean`		`true` if a course is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCourseId
Description	Gets the `Id` of the `Course`.
Return	`osid.id.Id`		the course `Id`
Errors	ILLEGAL_STATE		`hasCourse()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getCourse
Description	Gets the `Course`.
Return	`osid.course.Course`		the course
Errors	ILLEGAL_STATE		`hasCourse()` is `false`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	hasAssessment
Description	Tests if this award applies to a specific assessment. If `hasAssessment()` is `true`, `hasCourse()` and `hasProgram()` must be `false`.
Return	`boolean`		`true` if an assessment is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAssessmentId
Description	Gets the `Id` of the `Assessment`.
Return	`osid.id.Id`		the assessment `Id`
Errors	ILLEGAL_STATE		`hasAssessment()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getAssessment
Description	Gets the `Assessment`.
Return	`osid.assessment.Assessment`		the assessment
Errors	ILLEGAL_STATE		`hasAssessment()` is `false`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getAwardEntryRecord
Description	Gets the award entry record corresponding to the given `AwardEntry` record `Type`. This method is used to retrieve an object implementing the requested record. The `awardEntryRecordType` may be the `Type` returned in `getRecordTypes()` or any of its parents in a `Type` hierarchy where `hasRecordType(awardEntryRecordType)` is `true`.
Parameters	`osid.type.Type`	`awardEntryRecordType`	the type of award entry record to retrieve
Return	`osid.course.chronicle.records.AwardEntryRecord`		the award entry 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.