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

Interface	osid.course.chronicle.AssessmentEntryForm
Implements	`osid.OsidRuleForm`
Implements	`osid.OsidAggregateableForm`
Implemented By	`osid.course.chronicle.batch.AssessmentEntryBatchForm`
Used By	`osid.course.chronicle.AssessmentEntryAdminSession`
Description	This is the form for creating and updating `AssessmentEntries`. Like all `OsidForm` objects, various data elements may be set here for use in the create and update methods in the `ChronicleAdminSession`. For each data element that may be set, metadata may be examined to provide display hints or data constraints.
Method	getDateCompletedMetadata
Description	Gets the metadata for the completed date.
Return	`osid.Metadata`		metadata for the completion date
Compliance	`mandatory`		This method must be implemented.
Method	setDateCompleted
Description	Sets the completed date.
Parameters	`osid.calendaring.DateTime`	`date`	the new completion date
Errors	INVALID_ARGUMENT		`date` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`date` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearDateCompleted
Description	Clears the date completed.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getProgramMetadata
Description	Gets the metadata for the program.
Return	`osid.Metadata`		metadata for the program
Compliance	`mandatory`		This method must be implemented.
Method	setProgram
Description	Sets the program.
Parameters	`osid.id.Id`	`programId`	the new program
Errors	INVALID_ARGUMENT		`programId` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`programId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearProgram
Description	Clears the program.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getCourseMetadata
Description	Gets the metadata for the course.
Return	`osid.Metadata`		metadata for the course
Compliance	`mandatory`		This method must be implemented.
Method	setCourse
Description	Sets the course.
Parameters	`osid.id.Id`	`courseId`	the new course
Errors	INVALID_ARGUMENT		`courseId` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`courseId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearCourse
Description	Clears the course.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getGradeMetadata
Description	Gets the metadata for the 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
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	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	getScoreScaleMetadata
Description	Gets the metadata for the score system.
Return	`osid.Metadata`		metadata for the grade system
Compliance	`mandatory`		This method must be implemented.
Method	setScoreScale
Description	Sets the score system.
Parameters	`osid.id.Id`	`gradeSystemId`	the new grade system
Errors	INVALID_ARGUMENT		`gradeSystemId` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`gradeSystemId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearScoreScale
Description	Clears the score system.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getScoreMetadata
Description	Gets the metadata for the 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
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
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	getAssessmentEntryFormRecord
Description	Gets the `AssessmentEntryFormRecord` corresponding to the given assessment entry record `Type`.
Parameters	`osid.type.Type`	`assessmentEntryFormRecordType`	an assessment entry record type
Return	`osid.course.chronicle.records.AssessmentEntryFormRecord`		the assessment entry form record
Errors	NULL_ARGUMENT		`assessmentEntryFormRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(assessmentEntryFormRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.