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

Interface	osid.course.requisite.LearningObjectiveRequirementForm
Implements	`osid.OsidRuleForm`
Implements	`osid.OsidAggregateableForm`
Used By	`osid.course.requisite.RequisiteAdminSession`
Description	This is the form for creating and updating `LearningObjectiveRequirements`. 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`, `LearningObjectiveRequirementForm` is stateful and must not be accessed by multiple processing threads.
Method	getLearningObjectivesMetadata
Description	Gets the metadata for the learning objectives.
Return	`osid.Metadata`		metadata for the learning objectives
Compliance	`mandatory`		This method must be implemented.
Method	setLearningObjectives
Description	Sets the learning objectives.
Parameters	`osid.id.Id[]`	`learningObjectiveIds`	the new learning objectives
Errors	INVALID_ARGUMENT		`learningObjectiveIds` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`learningObjectiveIds` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearLearningObjectives
Description	Removes the learning objectives.
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 learning objectives.
Return	`osid.Metadata`		metadata for the minimum number
Compliance	`mandatory`		This method must be implemented.
Method	setMinimumNumber
Description	Sets the minimum number of learning objectives 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 learning objectives.
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 learning objectives 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 learning objectives 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	getMinimumProficiencyMetadata
Description	Gets the metadata for the minimum proficiency grade.
Return	`osid.Metadata`		metadata for the minimum proficiency
Compliance	`mandatory`		This method must be implemented.
Method	setMinimumProficiency
Description	Sets the minimum proficiency grade.
Parameters	`osid.id.Id`	`gradeId`	the new proficiency
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	clearMinimumProficiency
Description	Clears the minimum proficiency grade.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getLearningObjectiveRequirementFormRecord
Description	Gets the `LearningObjectiveRequirementFormRecord` corresponding to the given learning obective requirement record `Type`.
Parameters	`osid.type.Type`	`learningObectiveRequirementRecordType`	a learning obective requirement record type
Return	`osid.course.requisite.records.LearningObjectiveRequirementFormRecord`		the learning obective requirement form record
Errors	NULL_ARGUMENT		`learningObectiveRequirementRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(learningObectiveRequirementRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.