org.osid.assessment

Interface AssessmentForm

All Superinterfaces:

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

All Known Subinterfaces:

AssessmentBatchForm

public interface AssessmentForm
extends OsidObjectForm

This is the form for creating and updating Assessments. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the AssessmentAdminSession. 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	clearLevel() Clears the grade level.
void	clearRubric() Clears the rubric.
AssessmentFormRecord	getAssessmentFormRecord(Type assessmentRecordType) Gets the AssessmentFormRecord corresponding to the given assessment record Type.
Metadata	getLevelMetadata() Gets the metadata for a grade level.
Metadata	getRubricMetadata() Gets the metadata for a rubric assessment.
void	setLevel(Id gradeId) Sets the level of difficulty expressed as a Grade.
void	setRubric(Id assessmentId) Sets the rubric expressed as another assessment.

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

Method Detail

getLevelMetadata

Metadata getLevelMetadata()

Gets the metadata for a grade level.

Returns:

metadata for the grade level

Compliance:

mandatory - This method must be implemented.

setLevel

void setLevel(Id gradeId)

Sets the level of difficulty expressed as a Grade.

Parameters:

gradeId - the grade level

Throws:

InvalidArgumentException - gradeId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - gradeId is null

Compliance:

mandatory - This method must be implemented.

clearLevel

void clearLevel()

Clears the grade level.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getRubricMetadata

Metadata getRubricMetadata()

Gets the metadata for a rubric assessment.

Returns:

metadata for the assesment

Compliance:

mandatory - This method must be implemented.

setRubric

void setRubric(Id assessmentId)

Sets the rubric expressed as another assessment.

Parameters:

assessmentId - the assessment Id

Throws:

InvalidArgumentException - assessmentId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - assessmentId is null

Compliance:

mandatory - This method must be implemented.

clearRubric

void clearRubric()

Clears the rubric.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getAssessmentFormRecord

AssessmentFormRecord getAssessmentFormRecord(Type assessmentRecordType)
                                             throws OperationFailedException

Gets the AssessmentFormRecord corresponding to the given assessment record Type.

Parameters:

assessmentRecordType - the assessment record type

Returns:

the assessment record

Throws:

NullArgumentException - assessmentRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(assessmentRecordType) is false

Compliance:

mandatory - This method must be implemented.