org.osid.course.requisite

Interface LearningObjectiveRequirementForm

All Superinterfaces:

Extensible, Identifiable, OsidAggregateableForm, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidOperableForm, OsidRuleForm, Suppliable

public interface LearningObjectiveRequirementForm
extends OsidRuleForm, OsidAggregateableForm

This is the form for creating and updating LearningObjectiveRequirements. 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 Summary

Methods

Modifier and Type	Method and Description
void	clearMinimumProficiency() Clears the minimum proficiency grade.
LearningObjectiveRequirementFormRecord	getLearningObjectiveRequirementFormRecord(Type learningObectiveRequirementRecordType) Gets the LearningObjectiveRequirementFormRecord corresponding to the given learning obective requirement record Type.
Metadata	getMinimumProficiencyMetadata() Gets the metadata for the minimum proficiency grade.
void	setMinimumProficiency(Id gradeId) Sets the minimum proficiency grade.

Methods inherited from interface org.osid.OsidRuleForm

clearRule, getRuleMetadata, setRule

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.OsidOperableForm

clearDisabled, clearEnabled, getDisabledMetadata, getEnabledMetadata, setDisabled, setEnabled

Method Detail

getMinimumProficiencyMetadata

Metadata getMinimumProficiencyMetadata()

Gets the metadata for the minimum proficiency grade.

Returns:

metadata for the minimum proficiency

Compliance:

mandatory - This method must be implemented.

setMinimumProficiency

void setMinimumProficiency(Id gradeId)

Sets the minimum proficiency grade.

Parameters:

gradeId - the new proficiency

Throws:

InvalidArgumentException - gradeId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - gradeId is null

Compliance:

mandatory - This method must be implemented.

clearMinimumProficiency

void clearMinimumProficiency()

Clears the minimum proficiency grade.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getLearningObjectiveRequirementFormRecord

LearningObjectiveRequirementFormRecord getLearningObjectiveRequirementFormRecord(Type learningObectiveRequirementRecordType)
                                                                                 throws OperationFailedException

Gets the LearningObjectiveRequirementFormRecord corresponding to the given learning obective requirement record Type.

Parameters:

learningObectiveRequirementRecordType - a learning obective requirement record type

Returns:

the learning obective requirement form record

Throws:

NullArgumentException - learningObectiveRequirementRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(learningObectiveRequirementRecordType) is false

Compliance:

mandatory - This method must be implemented.