OSID - osid.course.chronicle.ProgramEntry Service Interface Definition

Interface	osid.course.chronicle.ProgramEntry
Implements	`osid.OsidRelationship`
Description	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	getStudentId
Description	Gets the `Id` of the `Student.`
Return	`osid.id.Id`		the student `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getStudent
Description	Gets the `Student.`
Return	`osid.resource.Resource`		the student
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getProgramId
Description	Gets the `Id` of the `Program.`
Return	`osid.id.Id`		the program `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getProgram
Description	Gets the `Program.`
Return	`osid.course.program.Program`		the program
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getAdmissionDate
Description	Gets the date in which the student was admitted.
Return	`osid.calendaring.DateTime`		the admission date
Compliance	`mandatory`		This method must be implemented.
Method	isComplete
Description	Tests if the program has been completed. If this entry is for summary information an a past term, `isComplete()` may be `true.`
Return	`boolean`		`true` if the program has been completed, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	isForTerm
Description	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.
Return	`boolean`		`true` if the program has a term, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getTermId
Description	Gets the `Id` of the `Term.`
Return	`osid.id.Id`		the term `Id`
Errors	ILLEGAL_STATE		`isForTerm()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getTerm
Description	Gets the `Term.`
Return	`osid.course.Term`		the term
Errors	ILLEGAL_STATE		`isForTerm()` is `false`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getCreditScaleId
Description	Gets the `Id` of the `GradeSystem.`
Return	`osid.id.Id`		the grade system `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getCreditScale
Description	Gets the `GradeSystem.`
Return	`osid.grading.GradeSystem`		the grade system
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getCreditsEarned
Description	Gets the number of credits earned in this program or earned within the included term.
Return	`decimal`		the credits earned
Compliance	`mandatory`		This method must be implemented.
Method	hasGPA
Description	Tests if a cumulative GPA in this program of the GPA for the included term.
Return	`boolean`		`true` if a GPA is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getGPAScaleId
Description	Gets the `Id` of the `GradeSystem.`
Return	`osid.id.Id`		the grade system `Id`
Errors	ILLEGAL_STATE		`hasGPA()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getGPAScale
Description	Gets the `GradeSystem.`
Return	`osid.grading.GradeSystem`		the grade system
Errors	ILLEGAL_STATE		`hasGPA()` is `false`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getGPA
Description	Gets the cumulative GPA in this porgram or within the included term.
Return	`decimal`		the GPA
Errors	ILLEGAL_STATE		`hasGPA()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	hasEnrollments
Description	Tests if `Enrollments` are available.
Return	`boolean`		`true` if enrollments are available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getEnrollmentIds
Description	Gets the `Ids` of the `Enrollments.`
Return	`osid.id.IdList`		the enrollment `Ids`
Errors	ILLEGAL_STATE		`hasEnrollments()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getEnrollments
Description	Gets the `Enrollments.`
Return	`osid.course.program.EnrollmentList`		the enrollments
Errors	ILLEGAL_STATE		`hasEnrollments()` is `false`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getProgramEntryRecord
Description	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	`osid.type.Type`	`programEntryRecordType`	the type of program entry record to retrieve
Return	`osid.course.chronicle.records.ProgramEntryRecord`		the program entry record
Errors	NULL_ARGUMENT		`programEntryRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(programEntryRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.