OSID - osid.course.requisite.CourseRequirementForm Service Interface Definition

Interface	osid.course.requisite.CourseRequirementForm
Implements	`osid.OsidRuleForm`
Implements	`osid.OsidAggregateableForm`
Description	This is the form for creating and updating `CourseRequirements.` Like all `OsidForm` objects, various data elements may be set here for use in the create and update methods in the `RequisiteAdminSession.` For each data element that may be set, metadata may be examined to provide display hints or data constraints.
Method	getRequiresCompletionMetadata
Description	Gets the metadata for the requires completion flag.
Return	`osid.Metadata`		metadata for the requires completion flag
Compliance	`mandatory`		This method must be implemented.
Method	setRequiresCompletion
Description	Sets the requires completion flag.
Parameters	`boolean`	`completion`	the new requires completion flag
Errors	INVALID_ARGUMENT		`completion` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearRequiresCompletion
Description	Clears the requires completion flag.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getTimeframeMetadata
Description	Gets the metadata for the timeframe.
Return	`osid.Metadata`		metadata for the timeframe
Compliance	`mandatory`		This method must be implemented.
Method	setTimeframe
Description	Sets the timeframe.
Parameters	`osid.calendaring.Duration`	`duration`	the new duration
Errors	INVALID_ARGUMENT		`duration` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`duration` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearTimeframe
Description	Clears the timeframe.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getMinimumGradeMetadata
Description	Gets the metadata for the minimum grade.
Return	`osid.Metadata`		metadata for the minimum grade
Compliance	`mandatory`		This method must be implemented.
Method	setMinimumGrade
Description	Sets the minimum 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	clearMinimumGrade
Description	Clears the minimum grade.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getMinimumScoreSystemMetadata
Description	Gets the metadata for the minimum score system.
Return	`osid.Metadata`		metadata for the minimum score system
Compliance	`mandatory`		This method must be implemented.
Method	setMinimumScoreSystem
Description	Sets the minimum 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	clearMinimumScoreSystem
Description	Clears the minimum score system.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getMinimumScoreMetadata
Description	Gets the metadata for the minimum score.
Return	`osid.Metadata`		metadata for the minimum score
Compliance	`mandatory`		This method must be implemented.
Method	setMinimumScore
Description	Sets the minimum score.
Parameters	`decimal`	`score`	the new minimum score
Errors	INVALID_ARGUMENT		`score` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearMinimumScore
Description	Clears the minimum score.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getMinimumEarnedCreditsMetadata
Description	Gets the metadata for the minimum earned credits
Return	`osid.Metadata`		metadata for the minimum earned credits
Compliance	`mandatory`		This method must be implemented.
Method	setMinimumEarnedCredits
Description	Sets the minimum earned credits.
Parameters	`decimal`	`credits`	the new minimum earned credits
Errors	INVALID_ARGUMENT		`credits` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearMinimumEarnedCredits
Description	Clears the minimum earned credits.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getCourseRequirementFormRecord
Description	Gets the `CourseRequirementFormRecord` corresponding to the given course requirement record `Type.`
Parameters	`osid.type.Type`	`courseRequirementRecordType`	a course requirement record type
Return	`osid.course.requisite.records.CourseRequirementFormRecord`		the course requirement form record
Errors	NULL_ARGUMENT		`courseRequirementRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(courseRequirementRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.