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

Modifier and Type	Method	Description
void	clearLevel()	Clears the grade level.
void	clearRubric()	Clears the rubric.
AssessmentFormRecord	getAssessmentFormRecord(Type assessmentFormRecordType)	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 Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type.

Methods inherited from interface Identifiable

getId, isCurrent

Modifier and Type	Method	Description
Id	getId()	Gets the Id associated with this instance of this OSID object.
boolean	isCurrent()	Tests to see if the last method invoked retrieved up-to-date data.

Methods inherited from interface OsidExtensibleForm

getRequiredRecordTypes

Modifier and Type	Method	Description
TypeList	getRequiredRecordTypes()	Gets the minimum required record types for successful submission of this OsidForm.

Methods inherited from interface OsidForm

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

Modifier and Type	Method	Description
Locale	getDefaultLocale()	Gets a default locale for the form.
Metadata[]	getInvalidMetadata()	Gets a list of metadata for the elements in this form which are not valid.
Metadata	getJournalCommentMetadata()	Gets the metadata for the comment corresponding to this form submission.
LocaleList	getLocales()	Gets the locales available for this form.
DisplayText[]	getValidationMessages()	Gets text messages corresponding to additional instructions to pass form validation.
boolean	isForUpdate()	Tests if this form is for an update operation.
boolean	isValid()	Tests if this form is in a valid state for submission.
void	setJournalComment(String comment)	Sets a comment.
void	setLocale(Type languageType, Type scriptType)	Specifies a language and script type for the form.

Methods inherited from interface OsidObjectForm

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

Modifier and Type	Method	Description
void	clearDescription()	Clears the description.
void	clearDisplayName()	Clears the display name.
void	clearGenusType()	Clears the genus type.
Metadata	getDescriptionMetadata()	Gets the metadata for a description.
Metadata	getDisplayNameMetadata()	Gets the metadata for a display name.
Metadata	getGenusTypeMetadata()	Gets the metadata for a genus type.
void	setDescription(String description)	Sets a description.
void	setDisplayName(String displayName)	Sets a display name.
void	setGenusType(Type genusType)	Sets a genus.

Method Details

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 assessmentFormRecordType)
                                      throws OperationFailedException

Gets the AssessmentFormRecord corresponding to the given assessment record Type.

Parameters:

assessmentFormRecordType - the assessment record type

Returns:

the assessment record

Throws:

NullArgumentException - assessmentFormRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(assessmentFormRecordType) is false

Compliance:

mandatory - This method must be implemented.