OSID Logo
OSID Specifications
course chronicle package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.chronicle.AwardEntry
Implementsosid.OsidRelationship
Description

An AwardEntry represents an academic record entry for a recognition.

MethodgetStudentId
Description

Gets the Id of the Student.

Returnosid.id.Idthe student Id
CompliancemandatoryThis method must be implemented.
MethodgetStudent
Description

Gets the Student.

Returnosid.resource.Resourcethe student
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetAwardId
Description

Gets the Id of the Award.

Returnosid.id.Idthe award Id
CompliancemandatoryThis method must be implemented.
MethodgetAward
Description

Gets the Award.

Returnosid.recognition.Awardthe award
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetDateAwarded
Description

Gets the award date.

Returnosid.calendaring.DateTimethe date awarded
CompliancemandatoryThis method must be implemented.
MethodhasProgram
Description

Tests if this award applies to a specific program. If hasProgram() is true, hasCourse() and hasAssessment() must be false.

Returnboolean true if a program is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetProgramId
Description

Gets the Id of the Program.

Returnosid.id.Idthe program Id
ErrorsILLEGAL_STATE hasProgram() is false
CompliancemandatoryThis method must be implemented.
MethodgetProgram
Description

Gets the Program.

Returnosid.course.program.Programthe program
ErrorsILLEGAL_STATE hasProgram() is false
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodhasCourse
Description

Tests if this award applies to a specific course. If hasCourse() is true, hasProgram() and hasAssessment() must be false.

Returnboolean true if a course is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetCourseId
Description

Gets the Id of the Course.

Returnosid.id.Idthe course Id
ErrorsILLEGAL_STATE hasCourse() is false
CompliancemandatoryThis method must be implemented.
MethodgetCourse
Description

Gets the Course.

Returnosid.course.Coursethe course
ErrorsILLEGAL_STATE hasCourse() is false
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodhasAssessment
Description

Tests if this award applies to a specific assessment. If hasAssessment() is true, hasCourse() and hasProgram() must be false.

Returnboolean true if an assessment is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetAssessmentId
Description

Gets the Id of the Assessment.

Returnosid.id.Idthe assessment Id
ErrorsILLEGAL_STATE hasAssessment() is false
CompliancemandatoryThis method must be implemented.
MethodgetAssessment
Description

Gets the Assessment.

Returnosid.assessment.Assessmentthe assessment
ErrorsILLEGAL_STATE hasAssessment() is false
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetAwardEntryRecord
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 .

Parametersosid.type.TypeawardEntryRecordTypethe type of award entry record to retrieve
Returnosid.course.chronicle.records.AwardEntryRecordthe award entry record
ErrorsNULL_ARGUMENT awardEntryRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(awardEntryRecordType) is false
CompliancemandatoryThis method must be implemented.