public interface ProgramEntry extends OsidRelationship
A ProgramEntry
represents an academic record entry for a
Program.
The fields in the ProgramEntry
may
be for the entire enrollment through the academic career or specific to an
academic Term.
A ProgramEntry
is also an OsidRelationship
between the student and Program.
The effectiveness
of the OsidRelationship
describes the effectiveness of the
academic record entry itself, not the student's enrollment in the
Program.
A ProgramEntry
may be superseded with a
manual update or forced entry and the temporal nature of the relationship
provides a history of changes to the academic record.
Modifier and Type | Method and Description |
---|---|
DateTime |
getAdmissionDate()
Gets the date in which the student was admitted.
|
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 program or earned within the
included term.
|
IdList |
getEnrollmentIds()
Gets the
Ids of the Enrollments. |
EnrollmentList |
getEnrollments()
Gets the
Enrollments. |
java.math.BigDecimal |
getGPA()
Gets the cumulative GPA in this porgram or within the included term.
|
GradeSystem |
getGPAScale()
Gets the
GradeSystem. |
Id |
getGPAScaleId()
Gets the
Id of the GradeSystem. |
Program |
getProgram()
Gets the
Program. |
ProgramEntryRecord |
getProgramEntryRecord(Type programEntryRecordType)
Gets the program entry record corresponding to the given
ProgramEntry record Type. |
Id |
getProgramId()
Gets the
Id of the Program. |
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 |
hasEnrollments()
Tests if
Enrollments are available. |
boolean |
hasGPA()
Tests if a cumulative GPA in this program of the GPA for the included
term.
|
boolean |
isComplete()
Tests if the program has been completed.
|
boolean |
isForTerm()
Tests if this entry is a progression entry applying to a single term.
|
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 getProgramId()
Id
of the Program.
Id
mandatory
- This method must be implemented. Program getProgram() throws OperationFailedException
Program.
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. DateTime getAdmissionDate()
mandatory
- This method must be implemented. boolean isComplete()
isComplete()
may be
true.
true
if the program has been completed,
false
otherwisemandatory
- This method must be implemented. boolean isForTerm()
isForTerm()
is
false,
this entry applies to the entire enrollement period. true
if the program has a term, false
otherwisemandatory
- This method must be implemented. Id getTermId()
Id
of the Term.
Id
IllegalStateException
- isForTerm()
is
false
mandatory
- This method must be implemented. Term getTerm() throws OperationFailedException
Term.
IllegalStateException
- isForTerm()
is
false
OperationFailedException
- unable to complete requestmandatory
- 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 hasGPA()
true
if a GPA is available, false
otherwisemandatory
- This method must be implemented. Id getGPAScaleId()
Id
of the GradeSystem.
Id
IllegalStateException
- hasGPA()
is
false
mandatory
- This method must be implemented. GradeSystem getGPAScale() throws OperationFailedException
GradeSystem.
IllegalStateException
- hasGPA()
is
false
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. java.math.BigDecimal getGPA()
IllegalStateException
- hasGPA()
is
false
mandatory
- This method must be implemented. boolean hasEnrollments()
Enrollments
are available. true
if enrollments are available, false
otherwisemandatory
- This method must be implemented. IdList getEnrollmentIds()
Ids
of the Enrollments.
Ids
IllegalStateException
- hasEnrollments()
is false
mandatory
- This method must be implemented. EnrollmentList getEnrollments() throws OperationFailedException
Enrollments.
IllegalStateException
- hasEnrollments()
is false
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. ProgramEntryRecord getProgramEntryRecord(Type programEntryRecordType) throws OperationFailedException
ProgramEntry
record Type.
This method is used
to retrieve an object implementing the requested record. The
programEntryRecordType
may be the Type
returned
in getRecordTypes()
or any of its parents in a
Type
hierarchy where
hasRecordType(programEntryRecordType)
is true
.programEntryRecordType
- the type of program entry record to
retrieveNullArgumentException
- programEntryRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(programEntryRecordType)
is false
mandatory
- This method must be implemented.