Interface ResultForm

All Superinterfaces:

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

All Known Subinterfaces:

ResultBatchForm

public interface ResultForm
extends OsidObjectForm, OsidTemporalForm, OsidSubjugateableForm

This is the form for creating and updating Results. Like all OsidForms, various data elements may be set here for use in the create and update methods in the ResultAdminSession. 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	clearGrade()	Clears the grade.
void	clearValue()	Clears the value.
Metadata	getGradeMetadata()	Gets the metadata for a grade.
ResultFormRecord	getResultFormRecord(Type resultRecordType)	Gets the ResultFormRecord interface corresponding to the given result record Type.
Metadata	getValueMetadata()	Gets the metadata for a value/
void	setGrade(Id gradeId)	Sets the grade.
void	setValue(BigDecimal value)	Sets the value.

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.

Methods inherited from interface OsidTemporalForm

clearEndDate, clearStartDate, getEndDateMetadata, getStartDateMetadata, setEndDate, setStartDate

Modifier and Type	Method	Description
void	clearEndDate()	Clears the end date.
void	clearStartDate()	Clears the start date.
Metadata	getEndDateMetadata()	Gets the metadata for an end date.
Metadata	getStartDateMetadata()	Gets the metadata for a start date.
void	setEndDate(DateTime date)	Sets the end date.
void	setStartDate(DateTime date)	Sets the start date.

Method Details

getGradeMetadata

Metadata getGradeMetadata()

Gets the metadata for a grade.

Returns:

metadata for the grade

Compliance:

mandatory - This method must be implemented.

setGrade

void setGrade(Id gradeId)

Sets the grade.

Parameters:

gradeId - the grade Id

Throws:

InvalidArgumentException - gradeId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - gradeId is null

Compliance:

mandatory - This method must be implemented.

clearGrade

void clearGrade()

Clears the grade.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getValueMetadata

Metadata getValueMetadata()

Gets the metadata for a value/

Returns:

metadata for the value

Compliance:

mandatory - This method must be implemented.

setValue

void setValue(BigDecimal value)

Sets the value.

Parameters:

value - the value

Throws:

InvalidArgumentException - value is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearValue

void clearValue()

Clears the value.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getResultFormRecord

ResultFormRecord getResultFormRecord(Type resultRecordType)
                              throws OperationFailedException

Gets the ResultFormRecord interface corresponding to the given result record Type.

Parameters:

resultRecordType - the result record type

Returns:

the record

Throws:

NullArgumentException - resultRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(resultRecordType) is false

Compliance:

mandatory - This method must be implemented.