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

Interface	osid.course.requisite.AssessmentRequirementForm
Implements	`osid.OsidRuleForm`
Implements	`osid.OsidAggregateableForm`
Used By	`osid.course.requisite.RequisiteAdminSession`
Description	This is the form for creating and updating `AssessmentRequirements`. 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. Like all `OsidForms`, `AssessmentRequirementForm` is stateful and must not be accessed by multiple processing threads.
Method	getAssessmentsMetadata
Description	Gets the metadata for the assessments.
Return	`osid.Metadata`		metadata for the assessments
Compliance	`mandatory`		This method must be implemented.
Method	setAssessments
Description	Sets the assessments.
Parameters	`osid.id.Id[]`	`assessmentIds`	the new assessments
Errors	INVALID_ARGUMENT		`assessmentIds` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`assessmentIds` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAssessments
Description	Removes the assessments.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getIncludeEquivalentUnitsMetadata
Description	Gets the metadata for the include equivalent units flag.
Return	`osid.Metadata`		metadata for the include equivalent units flag
Compliance	`mandatory`		This method must be implemented.
Method	setIncludeEquivalentUnits
Description	Sets the include equivalent units flag.
Parameters	`boolean`	`includeEquivalentUnits`	the new include equivalent units flag
Errors	INVALID_ARGUMENT		`includeEquivalentUnits` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearIncludeEquivalentUnits
Description	Clears the include equivalent units flag.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getMinimumNumberMetadata
Description	Gets the metadata for the minimum number of assessments.
Return	`osid.Metadata`		metadata for the minimum number
Compliance	`mandatory`		This method must be implemented.
Method	setMinimumNumber
Description	Sets the minimum number of assessments to complete from the set.
Parameters	`cardinal`	`number`	the new minimum number
Errors	INVALID_ARGUMENT		`number` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearMinimumNumber
Description	Clears the minimum number of assessments.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getTargetSetNumberMetadata
Description	Gets the metadata for the target number of assessments in the set.
Return	`osid.Metadata`		metadata for the target set number
Compliance	`mandatory`		This method must be implemented.
Method	setTargetSetNumber
Description	Sets the target number of assessments in the set.
Parameters	`cardinal`	`number`	the new target set number
Errors	INVALID_ARGUMENT		`number` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearTargetSetNumber
Description	Clears the target set number.
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	getAssessmentRequirementFormRecord
Description	Gets the `AssessmentRequirementFormRecord` corresponding to the given assessment requirement record `Type`.
Parameters	`osid.type.Type`	`assessmentRequirementRecordType`	an assessment requirement record type
Return	`osid.course.requisite.records.AssessmentRequirementFormRecord`		the assessment requirement form record
Errors	NULL_ARGUMENT		`assessmentRequirementRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(assessmentRequirementRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.