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

Interface	osid.course.chronicle.AwardEntryForm
Implements	`osid.OsidRelationshipForm`
Implemented By	`osid.course.chronicle.batch.AwardEntryBatchForm`
Used By	`osid.course.chronicle.AwardEntryAdminSession`
Description	This is the form for creating and updating `AwardEntries`. Like all `OsidForm` objects, various data elements may be set here for use in the create and update methods in the `AwardEntryAdminSession`. For each data element that may be set, metadata may be examined to provide display hints or data constraints.
Method	getDateAwardedMetadata
Description	Gets the metadata for the award date.
Return	`osid.Metadata`		metadata for the award date
Compliance	`mandatory`		This method must be implemented.
Method	setDateAwarded
Description	Sets the award date.
Parameters	`osid.calendaring.DateTime`	`date`	the new 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	clearDateAwarded
Description	Clears the award date.
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	getAssessmentMetadata
Description	Gets the metadata for the assessment.
Return	`osid.Metadata`		metadata for the assessment
Compliance	`mandatory`		This method must be implemented.
Method	setAssessment
Description	Sets the assessment.
Parameters	`osid.id.Id`	`assessmentId`	the new assessment
Errors	INVALID_ARGUMENT		`assessmentId` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`assessmentId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAssessment
Description	Clears the assessment.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getAwardEntryFormRecord
Description	Gets the `AwardEntryFormRecord` corresponding to the given award entry record `Type`.
Parameters	`osid.type.Type`	`awardEntryRecordType`	an award entry record type
Return	`osid.course.chronicle.records.AwardEntryFormRecord`		the award entry form record
Errors	NULL_ARGUMENT		`awardEntryRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(awardEntryRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.