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

Interface	osid.course.chronicle.CourseEntry
Implements	`osid.OsidRelationship`
Used By	`osid.course.chronicle.CourseEntryAdminSession`
	`osid.course.chronicle.CourseEntryList`
	`osid.course.chronicle.CourseEntryLookupSession`
Description	A `CourseEntry` represents an academic record entry for a course. The fields in the `CourseEntry` are specific to a `Term` .
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	getCourseId
Description	Gets the `Id` of the `Course` .
Return	`osid.id.Id`		the course `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getCourse
Description	Gets the `Course` .
Return	`osid.course.Course`		the course
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getTermId
Description	Gets the `Id` of the `Term` .
Return	`osid.id.Id`		the term `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getTerm
Description	Gets the `Term` .
Return	`osid.course.Term`		the term
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	isRegistrationKnown
Description	Tests if the registration dates for this course entry are known.
Return	`boolean`		`true` if the course begin and end dates are known, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCourseBeginDate
Description	Gets the first date of the `Course` .
Return	`osid.calendaring.DateTime`		the course begin date
Errors	ILLEGAL_STATE		`isRegistrationKnown()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getCourseEndDate
Description	Gets the last date of the `Course` .
Return	`osid.calendaring.DateTime`		the course end date
Errors	ILLEGAL_STATE		`isRegistrationKnown()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	isComplete
Description	Tests if the course has been completed.
Return	`boolean`		`true` if the course has been completed, `false` otherwise
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 course.
Return	`decimal`		the credits earned
Compliance	`mandatory`		This method must be implemented.
Method	hasGrade
Description	Tests if a grade is available.
Return	`boolean`		`true` if a grade is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getGradeId
Description	Gets the `Id` of the `Grade` .
Return	`osid.id.Id`		the grade `Id`
Errors	ILLEGAL_STATE		`hasGrade()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getGrade
Description	Gets the `Grade` .
Return	`osid.grading.Grade`		the grade
Errors	ILLEGAL_STATE		`hasGrade()` is `false`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	hasScore
Description	Tests if a score is available.
Return	`boolean`		`true` if a score is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getScoreScaleId
Description	Gets the `Id` of the `GradeSystem` .
Return	`osid.id.Id`		the grade system `Id`
Errors	ILLEGAL_STATE		`hasScore()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getScoreScale
Description	Gets the `GradeSystem` .
Return	`osid.grading.GradeSystem`		the grade system
Errors	ILLEGAL_STATE		`hasScore()` is `false`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getScore
Description	Gets the cumulative score.
Return	`decimal`		the score
Errors	ILLEGAL_STATE		`hasScore()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	hasRegistrations
Description	Tests if `Registrations` are available.
Return	`boolean`		`true` if registrations are available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRegistrationIds
Description	Gets the `Ids` of the `Registrations` .
Return	`osid.id.IdList`		the registrations `Ids`
Errors	ILLEGAL_STATE		`hasRegistrations()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getRegistrations
Description	Gets the `Registrations` .
Return	`osid.course.registration.RegistrationList`		the registrations
Errors	ILLEGAL_STATE		`hasRegistrations()` is `false`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getCourseEntryRecord
Description	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	`osid.type.Type`	`courseEntryRecordType`	the type of course entry record to retrieve
Return	`osid.course.chronicle.records.CourseEntryRecord`		the course entry record
Errors	NULL_ARGUMENT		`courseEntryRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(courseEntryRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.