OSID - osid.learning.ProficiencyForm Service Interface Definition

Interface	osid.learning.ProficiencyForm
Implements	`osid.OsidRelationshipForm`
Implemented By	`osid.learning.batch.ProficiencyBatchForm`
Used By	`osid.learning.ProficiencyAdminSession`
Description	This is the form for creating and updating `Proficiencies`. Like all `OsidForms`, various data elements may be set here for use in the create and update methods in the `ProficiencyAdminSession` . For each data element that may be set, metadata may be examined to provide display hints or data constraints.
Method	getCompletionMetadata
Description	Gets the metadata for completion percentage.
Return	`osid.Metadata`		metadata for the completion percentage
Compliance	`mandatory`		This method must be implemented.
Method	setCompletion
Description	Sets the completion percentage.
Parameters	`decimal`	`completion`	the completion percentage
Errors	INVALID_ARGUMENT		`completion` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearCompletion
Description	Clears the completion.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getLevelMetadata
Description	Gets the metadata for a level.
Return	`osid.Metadata`		metadata for the grade level
Compliance	`mandatory`		This method must be implemented.
Method	setLevel
Description	Sets the level expressed as a `Grade`.
Parameters	`osid.id.Id`	`gradeId`	the grade `Id`
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	clearLevel
Description	Clears the level.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getProficiencyFormRecord
Description	Gets the `ProficiencyFormRecord` corresponding to the given proficiency record `Type`.
Parameters	`osid.type.Type`	`proficiencyRecordType`	a proficiency record type
Return	`osid.learning.records.ProficiencyFormRecord`		the proficiency form record
Errors	NULL_ARGUMENT		`proficiencyRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(proficiencyRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.