OSID - osid.grading.GradeEntryForm Service Interface Definition

Interface	osid.grading.GradeEntryForm
Implements	`osid.OsidRelationshipForm`
Implemented By	`osid.grading.batch.GradeEntryBatchForm`
Used By	`osid.grading.GradeEntryAdminSession`
Description	This is the form for creating and updating `GradeEntries`. Like all `OsidForm` objects, various data elements may be set here for use in the create and update methods in the `GradeEntryAdminSession`. For each data element that may be set, metadata may be examined to provide display hints or data constraints.
Method	getIgnoredForCalculationsMetadata
Description	Gets the metadata for the ignore flag.
Return	`osid.Metadata`		metadata for the ignore flag
Compliance	`mandatory`		This method must be implemented.
Method	setIgnoredForCalculations
Description	Sets the ignore for calculations flag.
Parameters	`boolean`	`ignore`	the new ignore flag
Errors	INVALID_ARGUMENT		`ignore` is invalid
Errors	NO_ACCESS		`ignore` cannot be modified
Compliance	`mandatory`		This method must be implemented.
Method	clearIgnoredForCalculations
Description	Clears the ignore for calculations flag.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getGradeMetadata
Description	Gets the metadata for a grade.
Return	`osid.Metadata`		metadata for the grade
Compliance	`mandatory`		This method must be implemented.
Method	setGrade
Description	Sets the grade.
Parameters	`osid.id.Id`	`gradeId`	the new grade
Errors	INVALID_ARGUMENT		`gradeId` is invalid or `GradebookColumn.getGradeSystem().isBasedOnGrades()` is `false`
	NO_ACCESS		`gradeId` cannot be modified
	NULL_ARGUMENT		`gradeId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearGrade
Description	Clears the grade.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getScoreMetadata
Description	Gets the metadata for a score.
Return	`osid.Metadata`		metadata for the score
Compliance	`mandatory`		This method must be implemented.
Method	setScore
Description	Sets the score.
Parameters	`decimal`	`score`	the new score
Errors	INVALID_ARGUMENT		`score` is invalid or `GradebookColumn.getGradeSystem().isBasedOnGrades()` is `true`
Errors	NO_ACCESS		`score` cannot be modified
Compliance	`mandatory`		This method must be implemented.
Method	clearScore
Description	Clears the score.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getGradeEntryFormRecord
Description	Gets the `GradeEntryFormRecord` corresponding to the given grade entry record `Type`.
Parameters	`osid.type.Type`	`gradeEntryRecordType`	the grade entry record type
Return	`osid.grading.records.GradeEntryFormRecord`		the grade entry form 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.