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

Interface	osid.course.chronicle.CourseEntryForm
Implements	`osid.OsidRelationshipForm`
Implemented By	`osid.course.chronicle.batch.CourseEntryBatchForm`
Used By	`osid.course.chronicle.CourseEntryAdminSession`
Description	This is the form for creating and updating `courseEntries`. Like all `OsidForm` objects, various data elements may be set here for use in the create and update methods in the `CourseEntryAdminSession`. For each data element that may be set, metadata may be examined to provide display hints or data constraints.
Method	getTermMetadata
Description	Gets the metadata for the term.
Return	`osid.Metadata`		metadata for the term
Compliance	`mandatory`		This method must be implemented.
Method	setTerm
Description	Sets the term.
Parameters	`osid.id.Id`	`termId`	the new term
Errors	INVALID_ARGUMENT		`termId` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`termId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearTerm
Description	Clears the term.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getIsRegistrationKnownMetadata
Description	Gets the metadata for the is registration known flag.
Return	`osid.Metadata`		metadata for the is registration known flag
Compliance	`mandatory`		This method must be implemented.
Method	setIsRegistrationKnown
Description	Sets the is registration known flag.
Parameters	`boolean`	`isRegistrationKnown`	the new is registration known flag
Errors	INVALID_ARGUMENT		`isRegistrationKnown` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearIsRegistrationKnown
Description	Clears the is registration known flag.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getCourseBeginDateMetadata
Description	Gets the metadata for the course begin date.
Return	`osid.Metadata`		metadata for the course begin date
Compliance	`mandatory`		This method must be implemented.
Method	setCourseBeginDate
Description	Sets the course begin date.
Parameters	`osid.calendaring.DateTime`	`courseBeginDate`	the new course begin date
Errors	INVALID_ARGUMENT		`courseBeginDate` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`courseBeginDate` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearCourseBeginDate
Description	Clears the course begin date.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getCourseEndDateMetadata
Description	Gets the metadata for the course end date.
Return	`osid.Metadata`		metadata for the course end date
Compliance	`mandatory`		This method must be implemented.
Method	setCourseEndDate
Description	Sets the course end date.
Parameters	`osid.calendaring.DateTime`	`courseEndDate`	the new course end date
Errors	INVALID_ARGUMENT		`courseEndDate` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`courseEndDate` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearCourseEndDate
Description	Clears the course end date.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getCompleteMetadata
Description	Gets the metadata for the completion flag.
Return	`osid.Metadata`		metadata for the complete flag
Compliance	`mandatory`		This method must be implemented.
Method	setComplete
Description	Sets the program is complete flag.
Parameters	`boolean`	`complete`	the new complete flag
Errors	INVALID_ARGUMENT		`complete` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearComplete
Description	Clears the complete flag.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getCreditScaleMetadata
Description	Gets the metadata for the credit scale.
Return	`osid.Metadata`		metadata for the credit scale
Compliance	`mandatory`		This method must be implemented.
Method	setCreditScale
Description	Sets the credit scale.
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	clearCreditScale
Description	Clears the credit scale.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getCreditsEarnedMetadata
Description	Gets the metadata for the credits earned.
Return	`osid.Metadata`		metadata for the credits earned
Compliance	`mandatory`		This method must be implemented.
Method	setCreditsEarned
Description	Sets the credits earned.
Parameters	`decimal`	`credits`	the new credits
Errors	INVALID_ARGUMENT		`credits` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearCreditsEarned
Description	Clears the credits earned.
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 scale.
Return	`osid.Metadata`		metadata for the score scale
Compliance	`mandatory`		This method must be implemented.
Method	setScoreScale
Description	Sets the score scale.
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 scale.
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	getCourseEntryFormRecord
Description	Gets the `CourseEntryFormRecord` corresponding to the given course entry record `Type`.
Parameters	`osid.type.Type`	`courseEntryRecordType`	a course entry record type
Return	`osid.course.chronicle.records.CourseEntryFormRecord`		the course entry form record
Errors	NULL_ARGUMENT		`courseEntryRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(courseEntryRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.