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

Interface	osid.course.requisite.ProgramRequirementForm
Implements	`osid.OsidRuleForm`
Implements	`osid.OsidAggregateableForm`
Used By	`osid.course.requisite.RequisiteAdminSession`
Description	This is the form for creating and updating `ProgramRequirements`. 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`, `ProgramRequirementForm` is stateful and must not be accessed by multiple processing threads.
Method	getProgramsMetadata
Description	Gets the metadata for the programs.
Return	`osid.Metadata`		metadata for the programs
Compliance	`mandatory`		This method must be implemented.
Method	setPrograms
Description	Sets the programs.
Parameters	`osid.id.Id[]`	`programIds`	the new programs
Errors	INVALID_ARGUMENT		`programIds` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`programIds` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearPrograms
Description	Removes the programs.
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 programs.
Return	`osid.Metadata`		metadata for the minimum number
Compliance	`mandatory`		This method must be implemented.
Method	setMinimumNumber
Description	Sets the minimum number of programs 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 programs.
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 programs 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 programs 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	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	getMinimumGPASystemMetadata
Description	Gets the metadata for the minimum GPA system.
Return	`osid.Metadata`		metadata for the minimum GPA system
Compliance	`mandatory`		This method must be implemented.
Method	setMinimumGPASystem
Description	Sets the minimum GPA 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	clearMinimumGPASystem
Description	Clears the minimum GPA system.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getMinimumGPAMetadata
Description	Gets the metadata for the minimum GPA.
Return	`osid.Metadata`		metadata for the minimum GPA
Compliance	`mandatory`		This method must be implemented.
Method	setMinimumGPA
Description	Sets the minimum GPA.
Parameters	`decimal`	`gpa`	the new grade
Errors	INVALID_ARGUMENT		`grade` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearMinimumGPA
Description	Clears the minimum GPA.
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	getProgramRequirementFormRecord
Description	Gets the `ProgramRequirementFormRecord` corresponding to the given program requirement record `Type`.
Parameters	`osid.type.Type`	`programRequirementRecordType`	a program requirement record type
Return	`osid.course.requisite.records.ProgramRequirementFormRecord`		the program requirement form record
Errors	NULL_ARGUMENT		`programRequirementRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(programRequirementRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.