OSID - osid.grading.GradeSystemForm Service Interface Definition

Interface	osid.grading.GradeSystemForm
Implements	`osid.OsidObjectForm`
Implements	`osid.OsidAggregateableForm`
Implemented By	`osid.grading.batch.GradeSystemBatchForm`
Used By	`osid.grading.GradeSystemAdminSession`
Description	This is the form for creating and updating `GradeSystems`. Like all `OsidForm` objects, various data elements may be set here for use in the create and update methods in the `GradeSystemAdminSession`. For each data element that may be set, metadata may be examined to provide display hints or data constraints.
Method	getBasedOnGradesMetadata
Description	Gets the metadata for a grade-based designation.
Return	`osid.Metadata`		metadata for the grade-based designation
Compliance	`mandatory`		This method must be implemented.
Method	setBasedOnGrades
Description	Sets the grade-based designation.
Parameters	`boolean`	`grades`	the grade-based designation
Errors	INVALID_ARGUMENT		`grades` is invalid
Errors	NO_ACCESS		`grades` cannot be modified
Compliance	`mandatory`		This method must be implemented.
Method	clearBasedOnGrades
Description	Clears the based on grades designation.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getLowestNumericScoreMetadata
Description	Gets the metadata for the lowest numeric score.
Return	`osid.Metadata`		metadata for the lowest numeric score
Compliance	`mandatory`		This method must be implemented.
Method	setLowestNumericScore
Description	Sets the lowest numeric score.
Parameters	`decimal`	`score`	the lowest numeric score
Errors	INVALID_ARGUMENT		`score` is invalid
Errors	NO_ACCESS		`score` cannot be modified
Compliance	`mandatory`		This method must be implemented.
Method	clearLowestNumericScore
Description	Clears the lowest score.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getNumericScoreIncrementMetadata
Description	Gets the metadata for the lowest numeric score.
Return	`osid.Metadata`		metadata for the lowest numeric score
Compliance	`mandatory`		This method must be implemented.
Method	setNumericScoreIncrement
Description	Sets the numeric score increment.
Parameters	`decimal`	`increment`	the numeric score increment
Errors	INVALID_ARGUMENT		`increment` is invalid
Errors	NO_ACCESS		`increment` cannot be modified
Compliance	`mandatory`		This method must be implemented.
Method	clearNumericScoreIncrement
Description	Clears the numeric score increment.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getHighestNumericScoreMetadata
Description	Gets the metadata for the highest numeric score.
Return	`osid.Metadata`		metadata for the highest numeric score
Compliance	`mandatory`		This method must be implemented.
Method	setHighestNumericScore
Description	Sets the highest numeric score.
Parameters	`decimal`	`score`	the highest numeric score
Errors	INVALID_ARGUMENT		`score` is invalid
Errors	NO_ACCESS		`score` cannot be modified
Compliance	`mandatory`		This method must be implemented.
Method	clearHighestNumericScore
Description	Clears the highest numeric score.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getGradeSystemFormRecord
Description	Gets the `GradeSystemFormRecord` corresponding to the given grade system record `Type`.
Parameters	`osid.type.Type`	`gradeSystemRecordType`	the grade system record type
Return	`osid.grading.records.GradeSystemFormRecord`		the grade system form record
Errors	NULL_ARGUMENT		`gradeSystemRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(gradeSystemRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.