org.osid.learning

Interface ProficiencyForm

All Superinterfaces:

Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidRelationshipForm, OsidTemporalForm, Suppliable

All Known Subinterfaces:

ProficiencyBatchForm

public interface ProficiencyForm
extends OsidRelationshipForm

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.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearCompletion() Clears the completion.
void	clearLevel() Clears the level.
Metadata	getCompletionMetadata() Gets the metadata for completion percentage.
Metadata	getLevelMetadata() Gets the metadata for a level.
ProficiencyFormRecord	getProficiencyFormRecord(Type proficiencyRecordType) Gets the ProficiencyFormRecord corresponding to the given proficiency record Type.
void	setCompletion(java.math.BigDecimal completion) Sets the completion percentage.
void	setLevel(Grade grade) Sets the level expressed as a Grade.

Methods inherited from interface org.osid.OsidObjectForm

clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType

Methods inherited from interface org.osid.OsidExtensibleForm

getRequiredRecordTypes

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidForm

getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.OsidTemporalForm

clearEndDate, clearStartDate, getEndDateMetadata, getStartDateMetadata, setEndDate, setStartDate

Method Detail

getCompletionMetadata

Metadata getCompletionMetadata()

Gets the metadata for completion percentage.

Returns:

metadata for the completion percentage

Compliance:

mandatory - This method must be implemented.

setCompletion

void setCompletion(java.math.BigDecimal completion)

Sets the completion percentage.

Parameters:

completion - the completion percentage

Throws:

InvalidArgumentException - completion is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearCompletion

void clearCompletion()

Clears the completion.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getLevelMetadata

Metadata getLevelMetadata()

Gets the metadata for a level.

Returns:

metadata for the grade level

Compliance:

mandatory - This method must be implemented.

setLevel

void setLevel(Grade grade)

Sets the level expressed as a Grade.

Parameters:

grade - the level

Throws:

InvalidArgumentException - grade is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - grade is null

Compliance:

mandatory - This method must be implemented.

clearLevel

void clearLevel()

Clears the level.

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getProficiencyFormRecord

ProficiencyFormRecord getProficiencyFormRecord(Type proficiencyRecordType)
                                               throws OperationFailedException

Gets the ProficiencyFormRecord corresponding to the given proficiency record Type.

Parameters:

proficiencyRecordType - a proficiency record type

Returns:

the proficiency form record

Throws:

NullArgumentException - proficiencyRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(proficiencyRecordType) is false

Compliance:

mandatory - This method must be implemented.