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

A CourseEntry represents an academic record entry for a course. The fields in the CourseEntry are specific to a Term.

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.
MethodgetCourseId
Description

Gets the Id of the Course.

Returnosid.id.Idthe course Id
CompliancemandatoryThis method must be implemented.
MethodgetCourse
Description

Gets the Course.

Returnosid.course.Coursethe course
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetTermId
Description

Gets the Id of the Term.

Returnosid.id.Idthe term Id
CompliancemandatoryThis method must be implemented.
MethodgetTerm
Description

Gets the Term.

Returnosid.course.Termthe term
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodisComplete
Description

Tests if the course has been completed.

Returnboolean true if the course has been completed, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetCreditScaleId
Description

Gets the Id of the GradeSystem.

Returnosid.id.Idthe grade system Id
CompliancemandatoryThis method must be implemented.
MethodgetCreditScale
Description

Gets the GradeSystem.

Returnosid.grading.GradeSystemthe grade system
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetCreditsEarned
Description

Gets the number of credits earned in this course.

Returndecimalthe credits earned
CompliancemandatoryThis method must be implemented.
MethodhasGrade
Description

Tests if a grade is available.

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

Gets the Id of the Grade.

Returnosid.id.Idthe grade Id
ErrorsILLEGAL_STATE hasGrade() is false
CompliancemandatoryThis method must be implemented.
MethodgetGrade
Description

Gets the Grade.

Returnosid.grading.Gradethe grade
ErrorsILLEGAL_STATE hasGrade() is false
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodhasScore
Description

Tests if a score is available.

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

Gets the Id of the GradeSystem.

Returnosid.id.Idthe grade system Id
ErrorsILLEGAL_STATE hasScore() is false
CompliancemandatoryThis method must be implemented.
MethodgetScoreScale
Description

Gets the GradeSystem.

Returnosid.grading.GradeSystemthe grade system
ErrorsILLEGAL_STATE hasScore() is false
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetScore
Description

Gets the cumulative score.

Returndecimalthe score
ErrorsILLEGAL_STATE hasScore() is false
CompliancemandatoryThis method must be implemented.
MethodhasRegistrations
Description

Tests if Registrations are available.

Returnboolean true if registrations are available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetRegistrationIds
Description

Gets the Ids of the Registrations.

Returnosid.id.IdListthe registrations Ids
ErrorsILLEGAL_STATE hasRegistrations() is false
CompliancemandatoryThis method must be implemented.
MethodgetRegistrations
Description

Gets the Registrations.

Returnosid.course.registration.RegistrationListthe registrations
ErrorsILLEGAL_STATE hasRegistrations() is false
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetCourseEntryRecord
Description

Gets the course entry record corresponding to the given CourseEntry record Type. This method is used to retrieve an object implementing the requested record. The courseEntryRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(courseEntryRecordType) is true .

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