org.osid.course.chronicle

Interface ProgramEntry

All Superinterfaces:

Browsable, Extensible, Identifiable, OsidObject, OsidRelationship, Temporal

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.

Method Summary

Methods

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.

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.

getProgramId

Id getProgramId()

Gets the Id of the Program.

Returns:

the program Id

Compliance:

mandatory - This method must be implemented.

getProgram

Program getProgram()
                   throws OperationFailedException

Gets the Program.

Returns:

the program

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getAdmissionDate

DateTime getAdmissionDate()

Gets the date in which the student was admitted.

Returns:

the admission date

Compliance:

mandatory - This method must be implemented.

isComplete

boolean isComplete()

Tests if the program has been completed. If this entry is for summary information an a past term, isComplete() may be true.

Returns:

true if the program has been completed, false otherwise

Compliance:

mandatory - This method must be implemented.

isForTerm

boolean isForTerm()

Tests if this entry is a progression entry applying to a single term. A program entry may provide summary information for the entire duration or for a single term. If isForTerm() is false, this entry applies to the entire enrollement period.

Returns:

true if the program has a term, false otherwise

Compliance:

mandatory - This method must be implemented.

getTermId

Id getTermId()

Gets the Id of the Term.

Returns:

the term Id

Throws:

IllegalStateException - isForTerm() is false

Compliance:

mandatory - This method must be implemented.

getTerm

Term getTerm()
             throws OperationFailedException

Gets the Term.

Returns:

the term

Throws:

IllegalStateException - isForTerm() is false

OperationFailedException - unable to complete request

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 program or earned within the included term.

Returns:

the credits earned

Compliance:

mandatory - This method must be implemented.

hasGPA

boolean hasGPA()

Tests if a cumulative GPA in this program of the GPA for the included term.

Returns:

true if a GPA is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getGPAScaleId

Id getGPAScaleId()

Gets the Id of the GradeSystem.

Returns:

the grade system Id

Throws:

IllegalStateException - hasGPA() is false

Compliance:

mandatory - This method must be implemented.

getGPAScale

GradeSystem getGPAScale()
                        throws OperationFailedException

Gets the GradeSystem.

Returns:

the grade system

Throws:

IllegalStateException - hasGPA() is false

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getGPA

java.math.BigDecimal getGPA()

Gets the cumulative GPA in this porgram or within the included term.

Returns:

the GPA

Throws:

IllegalStateException - hasGPA() is false

Compliance:

mandatory - This method must be implemented.

hasEnrollments

boolean hasEnrollments()

Tests if Enrollments are available.

Returns:

true if enrollments are available, false otherwise

Compliance:

mandatory - This method must be implemented.

getEnrollmentIds

IdList getEnrollmentIds()

Gets the Ids of the Enrollments.

Returns:

the enrollment Ids

Throws:

IllegalStateException - hasEnrollments() is false

Compliance:

mandatory - This method must be implemented.

getEnrollments

EnrollmentList getEnrollments()
                              throws OperationFailedException

Gets the Enrollments.

Returns:

the enrollments

Throws:

IllegalStateException - hasEnrollments() is false

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getProgramEntryRecord

ProgramEntryRecord getProgramEntryRecord(Type programEntryRecordType)
                                         throws OperationFailedException

Gets the program entry record corresponding to the given 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 .

Parameters:

programEntryRecordType - the type of program entry record to retrieve

Returns:

the program entry record

Throws:

NullArgumentException - programEntryRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(programEntryRecordType) is false

Compliance:

mandatory - This method must be implemented.