OSID Logo
OSID Specifications
learning package
Version 3.0.0
Release Candidate Preview
Interfaceosid.learning.ProficiencyForm
Implementsosid.OsidRelationshipForm
Description

This is the form for creating and updating Proficiencies. Like all OsidForm objects, 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.

MethodgetCompletionMetadata
Description

Gets the metadata for completion percentage.

Returnosid.Metadatametadata for the completion percentage
CompliancemandatoryThis method must be implemented.
MethodsetCompletion
Description

Sets the completion percentage.

Parametersdecimalcompletionthe completion percentage
ErrorsINVALID_ARGUMENT completion is invalid
NO_ACCESS Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodclearCompletion
Description

Clears the completion.

ErrorsNO_ACCESS Metadata.isRequired() or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetLevelMetadata
Description

Gets the metadata for a level.

Returnosid.Metadatametadata for the grade level
CompliancemandatoryThis method must be implemented.
MethodsetLevel
Description

Sets the level expressed as a Grade.

Parametersosid.grading.Gradegradethe level
ErrorsINVALID_ARGUMENT grade is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT grade is null
CompliancemandatoryThis method must be implemented.
MethodclearLevel
Description

Clears the level.

ErrorsNO_ACCESS Metadata.isRequired() or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetProficiencyFormRecord
Description

Gets the ProficiencyFormRecord corresponding to the given proficiency record Type.

Parametersosid.type.TypeproficiencyRecordTypea proficiency record type
Returnosid.learning.records.ProficiencyFormRecordthe proficiency form record
ErrorsNULL_ARGUMENT proficiencyRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(proficiencyRecordType) is false
CompliancemandatoryThis method must be implemented.