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

Interface	osid.course.requisite.CourseRequirementForm
Implements	`osid.OsidRuleForm`
Implements	`osid.OsidAggregateableForm`
Used By	`osid.course.requisite.RequisiteAdminSession`
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	getCoursesMetadata
Description	Gets the metadata for the courses.
Return	`osid.Metadata`		metadata for the courses
Compliance	`mandatory`		This method must be implemented.
Method	setCourses
Description	Sets the courses.
Parameters	`osid.id.Id[]`	`courseIds`	the new courses
Errors	INVALID_ARGUMENT		`courseIds` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`courseIds` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearCourses
Description	Removes the courses.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getRequiresSubjectAreaMetadata
Description	Gets the metadata for the requires subject area flag.
Return	`osid.Metadata`		metadata for the requires subject area flag
Compliance	`mandatory`		This method must be implemented.
Method	setRequiresSubjectArea
Description	Sets the requires subject area flag.
Parameters	`boolean`	`requiresSubjectArea`	the new requires subject area flag
Errors	INVALID_ARGUMENT		`requiresSubjectArea` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearRequiresSubjectArea
Description	Clears the requires subject area flag.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getSubjectAreaMetadata
Description	Gets the metadata for the subject area.
Return	`osid.Metadata`		metadata for the subject area
Compliance	`mandatory`		This method must be implemented.
Method	setSubjectArea
Description	Sets the subject area.
Parameters	`osid.id.Id`	`subjectAreaId`	the new subject area
Errors	INVALID_ARGUMENT		`subjectAreaId` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`subjectAreaId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearSubjectArea
Description	Clears the subject area.
Errors	NO_ACCESS		`Metadata.isRequired()` 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 courses.
Return	`osid.Metadata`		metadata for the minimum number
Compliance	`mandatory`		This method must be implemented.
Method	setMinimumNumber
Description	Sets the minimum number of courses 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 courses.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getMinimumNonTransferNumberMetadata
Description	Gets the metadata for the minimum number of non-transfer courses.
Return	`osid.Metadata`		metadata for the minimum non-transfer number
Compliance	`mandatory`		This method must be implemented.
Method	setMinimumNonTransferNumber
Description	Sets the minimum number of non-transfer courses to complete from the set.
Parameters	`cardinal`	`number`	the new minimum non-transfer number
Errors	INVALID_ARGUMENT		`number` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearMinimumNonTransferNumber
Description	Clears the minimum non-transfer number of courses.
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 courses 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 courses 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	getMinimumCreditsMetadata
Description	Gets the metadata for the minimum credits.
Return	`osid.Metadata`		metadata for the minimum credits
Compliance	`mandatory`		This method must be implemented.
Method	setMinimumCredits
Description	Sets the minimum credits.
Parameters	`decimal`	`credits`	the new minimum credits
Errors	INVALID_ARGUMENT		`credits` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearMinimumCredits
Description	Clears the minimum credits.
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 credit scale
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	getNonTransferCreditsMetadata
Description	Gets the metadata for the minimum non-transfer credits.
Return	`osid.Metadata`		metadata for the non-transfer credits
Compliance	`mandatory`		This method must be implemented.
Method	setNonTransferCredits
Description	Sets the minimum non-transfer credits.
Parameters	`decimal`	`credits`	the new minimum non-transfer credits
Errors	INVALID_ARGUMENT		`credits` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearNonTransferCredits
Description	Clears the non-transfer credits.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getTargetSetCreditsMetadata
Description	Gets the metadata for the target credits in the set.
Return	`osid.Metadata`		metadata for the target set credits
Compliance	`mandatory`		This method must be implemented.
Method	setTargetSetCredits
Description	Sets the target credits in the set.
Parameters	`decimal`	`credits`	the new target set credits
Errors	INVALID_ARGUMENT		`credits` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearTargetSetCredits
Description	Clears the target set credits.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
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.