org.osid.course.chronicle

Interface CourseEntry

All Superinterfaces:

Browsable, Extensible, Identifiable, OsidObject, OsidRelationship, Temporal

public interface CourseEntry
extends OsidRelationship

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

Method Summary

Methods

Modifier and Type	Method and Description
Course	getCourse() Gets the Course.
CourseEntryRecord	getCourseEntryRecord(Type courseEntryRecordType) Gets the course entry record corresponding to the given CourseEntry record Type.
Id	getCourseId() Gets the Id of the Course.
GradeSystem	getCreditScale() Gets the GradeSystem.
Id	getCreditScaleId() Gets the Id of the GradeSystem.
java.math.BigDecimal	getCreditsEarned() Gets the number of credits earned in this course.
Grade	getGrade() Gets the Grade.
Id	getGradeId() Gets the Id of the Grade.
IdList	getRegistrationIds() Gets the Ids of the Registrations.
RegistrationList	getRegistrations() Gets the Registrations.
java.math.BigDecimal	getScore() Gets the cumulative score.
GradeSystem	getScoreScale() Gets the GradeSystem.
Id	getScoreScaleId() Gets the Id of the GradeSystem.
Resource	getStudent() Gets the Student.
Id	getStudentId() Gets the Id of the Student.
Term	getTerm() Gets the Term.
Id	getTermId() Gets the Id of the Term.
boolean	hasGrade() Tests if a grade is available.
boolean	hasRegistrations() Tests if Registrations are available.
boolean	hasScore() Tests if a score is available.
boolean	isComplete() Tests if the course has been completed.

Methods inherited from interface org.osid.OsidRelationship

getEndReason, getEndReasonId, hasEndReason

Methods inherited from interface org.osid.OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Methods inherited from interface org.osid.Temporal

getEndDate, getStartDate, isEffective

Method Detail

getStudentId

Id getStudentId()

Gets the Id of the Student.

Returns:

the student Id

Compliance:

mandatory - This method must be implemented.

getStudent

Resource getStudent()
                    throws OperationFailedException

Gets the Student.

Returns:

the student

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getCourseId

Id getCourseId()

Gets the Id of the Course.

Returns:

the course Id

Compliance:

mandatory - This method must be implemented.

getCourse

Course getCourse()
                 throws OperationFailedException

Gets the Course.

Returns:

the course

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getTermId

Id getTermId()

Gets the Id of the Term.

Returns:

the term Id

Compliance:

mandatory - This method must be implemented.

getTerm

Term getTerm()
             throws OperationFailedException

Gets the Term.

Returns:

the term

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

isComplete

boolean isComplete()

Tests if the course has been completed.

Returns:

true if the course has been completed, false otherwise

Compliance:

mandatory - This method must be implemented.

getCreditScaleId

Id getCreditScaleId()

Gets the Id of the GradeSystem.

Returns:

the grade system Id

Compliance:

mandatory - This method must be implemented.

getCreditScale

GradeSystem getCreditScale()
                           throws OperationFailedException

Gets the GradeSystem.

Returns:

the grade system

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getCreditsEarned

java.math.BigDecimal getCreditsEarned()

Gets the number of credits earned in this course.

Returns:

the credits earned

Compliance:

mandatory - This method must be implemented.

hasGrade

boolean hasGrade()

Tests if a grade is available.

Returns:

true if a grade is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getGradeId

Id getGradeId()

Gets the Id of the Grade.

Returns:

the grade Id

Throws:

IllegalStateException - hasGrade() is false

Compliance:

mandatory - This method must be implemented.

getGrade

Grade getGrade()
               throws OperationFailedException

Gets the Grade.

Returns:

the grade

Throws:

IllegalStateException - hasGrade() is false

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

hasScore

boolean hasScore()

Tests if a score is available.

Returns:

true if a score is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getScoreScaleId

Id getScoreScaleId()

Gets the Id of the GradeSystem.

Returns:

the grade system Id

Throws:

IllegalStateException - hasScore() is false

Compliance:

mandatory - This method must be implemented.

getScoreScale

GradeSystem getScoreScale()
                          throws OperationFailedException

Gets the GradeSystem.

Returns:

the grade system

Throws:

IllegalStateException - hasScore() is false

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getScore

java.math.BigDecimal getScore()

Gets the cumulative score.

Returns:

the score

Throws:

IllegalStateException - hasScore() is false

Compliance:

mandatory - This method must be implemented.

hasRegistrations

boolean hasRegistrations()

Tests if Registrations are available.

Returns:

true if registrations are available, false otherwise

Compliance:

mandatory - This method must be implemented.

getRegistrationIds

IdList getRegistrationIds()

Gets the Ids of the Registrations.

Returns:

the registrations Ids

Throws:

IllegalStateException - hasRegistrations() is false

Compliance:

mandatory - This method must be implemented.

getRegistrations

RegistrationList getRegistrations()
                                  throws OperationFailedException

Gets the Registrations.

Returns:

the registrations

Throws:

IllegalStateException - hasRegistrations() is false

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getCourseEntryRecord

CourseEntryRecord getCourseEntryRecord(Type courseEntryRecordType)
                                       throws OperationFailedException

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 .

Parameters:

courseEntryRecordType - the type of course entry record to retrieve

Returns:

the course entry record

Throws:

NullArgumentException - courseEntryRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(courseEntryRecordType) is false

Compliance:

mandatory - This method must be implemented.