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.
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.
|
getEndReason, getEndReasonId, hasEndReason
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
getEndDate, getStartDate, isEffective
Id getStudentId()
Id
of the Student.
Id
mandatory
- This method must be implemented. Resource getStudent() throws OperationFailedException
Student.
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. Id getCourseId()
Id
of the Course.
Id
mandatory
- This method must be implemented. Course getCourse() throws OperationFailedException
Course.
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. Id getTermId()
Id
of the Term.
Id
mandatory
- This method must be implemented. Term getTerm() throws OperationFailedException
Term.
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. boolean isComplete()
true
if the course has been completed,
false
otherwisemandatory
- This method must be implemented. Id getCreditScaleId()
Id
of the GradeSystem.
Id
mandatory
- This method must be implemented. GradeSystem getCreditScale() throws OperationFailedException
GradeSystem.
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. java.math.BigDecimal getCreditsEarned()
mandatory
- This method must be implemented. boolean hasGrade()
true
if a grade is available, false
otherwisemandatory
- This method must be implemented. Id getGradeId()
Id
of the Grade.
Id
IllegalStateException
- hasGrade()
is
false
mandatory
- This method must be implemented. Grade getGrade() throws OperationFailedException
Grade.
IllegalStateException
- hasGrade()
is
false
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. boolean hasScore()
true
if a score is available, false
otherwisemandatory
- This method must be implemented. Id getScoreScaleId()
Id
of the GradeSystem.
Id
IllegalStateException
- hasScore()
is
false
mandatory
- This method must be implemented. GradeSystem getScoreScale() throws OperationFailedException
GradeSystem.
IllegalStateException
- hasScore()
is
false
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. java.math.BigDecimal getScore()
IllegalStateException
- hasScore()
is
false
mandatory
- This method must be implemented. boolean hasRegistrations()
Registrations
are available. true
if registrations are available,
false
otherwisemandatory
- This method must be implemented. IdList getRegistrationIds()
Ids
of the Registrations.
Ids
IllegalStateException
- hasRegistrations()
is false
mandatory
- This method must be implemented. RegistrationList getRegistrations() throws OperationFailedException
Registrations.
IllegalStateException
- hasRegistrations()
is false
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. CourseEntryRecord getCourseEntryRecord(Type courseEntryRecordType) throws OperationFailedException
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
.courseEntryRecordType
- the type of course entry record to
retrieveNullArgumentException
- courseEntryRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(courseEntryRecordType)
is false
mandatory
- This method must be implemented.