OSID - osid.grading.GradeEntry Service Interface Definition

Interface	osid.grading.GradeEntry
Implements	`osid.OsidRelationship`
Used By	`osid.grading.GradeEntry`
	`osid.grading.GradeEntryAdminSession`
	`osid.grading.GradeEntryList`
	`osid.grading.GradeEntryLookupSession`
Description	A `GradeEntry` represents an entry in a `Gradebook`.
Method	getGradebookColumnId
Description	Gets the `Id` of the `GradebookColumn`.
Return	`osid.id.Id`		the `Id` of the `GradebookColumn`
Compliance	`mandatory`		This method must be implemented.
Method	getGradebookColumn
Description	Gets the `GradebookColumn`.
Return	`osid.grading.GradebookColumn`		the `GradebookColumn`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getKeyResourceId
Description	Gets the `Id` of the key resource of this entry. The key resource may be a student or other applicable key to identify a row of grading entries.
Return	`osid.id.Id`		`Id` of the key resource
Compliance	`mandatory`		This method must be implemented.
Method	getKeyResource
Description	Gets the key resource of this entry. The key resource may be a student or other applicable key to identify a row of grading entries.
Return	`osid.resource.Resource`		the key resource
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	isDerived
Description	Tests if this is a calculated entry.
Return	`boolean`		`true` if this entry is a calculated entry, `false` otherwise. If `true`, then `overridesCalculatedEntry()` must be `false`.
Compliance	`mandatory`		This method must be implemented.
Method	overridesCalculatedEntry
Description	Tests if this is a manual entry that overrides a calculated entry.
Return	`boolean`		`true` if this entry overrides a calculated entry, `false` otherwise. If `true`, then `isDerived()` must be `false`.
Compliance	`mandatory`		This method must be implemented.
Method	getOverriddenCalculatedEntryId
Description	Gets the calculated entry `Id` this entry overrides.
Return	`osid.id.Id`		the calculated entry `Id`
Errors	ILLEGAL_STATE		`overridesDerivedEntry()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getOverriddenCalculatedEntry
Description	Gets the calculated entry this entry overrides.
Return	`osid.grading.GradeEntry`		the calculated entry
Errors	ILLEGAL_STATE		`overridesCalculatedEntry()` is `false`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	isIgnoredForCalculations
Description	Tests if this is entry should be ignored in any averaging, scaling or curve calculation.
Return	`boolean`		`true` if this entry is ignored, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	isGraded
Description	Tests if a grade or score has been assigned to this entry. Generally, an entry is created with a grade or score.
Return	`boolean`		`true` if a grade has been assigned, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getGradeId
Description	Gets the grade `Id` in this entry if the grading system is based on grades.
Return	`osid.id.Id`		the grade `Id`
Errors	ILLEGAL_STATE		`isGraded()` is `false` or `GradeSystem.isBasedOnGrades()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getGrade
Description	Gets the grade in this entry if the grading system is based on grades.
Return	`osid.grading.Grade`		the grade
Errors	ILLEGAL_STATE		`isGraded()` is `false` or `GradeSystem.isBasedOnGrades()` is `false`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getScore
Description	Gets the score in this entry if the grading system is not based on grades.
Return	`decimal`		the score
Errors	ILLEGAL_STATE		`isGraded()` is `false` or `GradeSystem.isBasedOnGrades()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getTimeGraded
Description	Gets the time the gradeable object was graded.
Return	`osid.calendaring.DateTime`		the timestamp of the grading entry
Errors	ILLEGAL_STATE		`isGraded()` is `false` or `isDerived()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getGraderId
Description	Gets the `Id` of the `Resource` that created this entry.
Return	`osid.id.Id`		the `Id` of the `Resource`
Errors	ILLEGAL_STATE		`isGraded()` is `false` or `isDerived()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getGrader
Description	Gets the `Resource` that created this entry.
Return	`osid.resource.Resource`		the `Resource`
Errors	ILLEGAL_STATE		`isGraded() is false or isDerived() is true`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getGradingAgentId
Description	Gets the `Id` of the `Agent` that created this entry.
Return	`osid.id.Id`		the `Id` of the `Agent`
Errors	ILLEGAL_STATE		`isGraded()` is `false` or `isDerived()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getGradingAgent
Description	Gets the `Agent` that created this entry.
Return	`osid.authentication.Agent`		the `Agent`
Errors	ILLEGAL_STATE		`isGraded() is false or isDerived() is true`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getGradeEntryRecord
Description	Gets the grade entry record corresponding to the given `GradeEntry` record `Type`. This method is used to retrieve an object implementing the requested record. The `gradeEntryRecordType` may be the `Type` returned in `getRecordTypes()` or any of its parents in a `Type` hierarchy where `hasRecordType(gradeEntryRecordType)` is `true`.
Parameters	`osid.type.Type`	`gradeEntryRecordType`	the type of the record to retrieve
Return	`osid.grading.records.GradeEntryRecord`		the grade entry record
Errors	NULL_ARGUMENT		`gradeEntryRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(gradeEntryRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.