Interface ResponseForm

All Superinterfaces:

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

public interface ResponseForm
extends OsidObjectForm

This is the form for submitting Responses .

Method Summary

Modifier and Type	Method	Description
void	clearValue(Id id)	Clears a value.
Metadata[]	getMetadata()	Gets the metadata for all the fields.
ResponseFormRecord	getResponseFormRecord(Type responseRecordType)	Gets the ResponseFormRecord corresponding to the given response record Type .
void	setValue(Id id, Object value)	Sets a value for a given field.

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

getMetadata

Metadata[] getMetadata()

Gets the metadata for all the fields. Some fields may be required and others optional.

Returns:

the metadata

Compliance:

mandatory - This method must be implemented.

setValue

void setValue(Id id,
 Object value)

Sets a value for a given field.

Parameters:

id - the Id of the metadata field

value - the value

Throws:

InvalidArgumentException - id or value is invalid

NullArgumentException - id or value is null

NoAccessException - value cannot be modified

Compliance:

mandatory - This method must be implemented.

clearValue

void clearValue(Id id)

Clears a value.

Parameters:

id - the Id of the metadata field

Throws:

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

NullArgumentException - id is null

Compliance:

mandatory - This method must be implemented.

getResponseFormRecord

ResponseFormRecord getResponseFormRecord(Type responseRecordType)
                                  throws OperationFailedException

Gets the ResponseFormRecord corresponding to the given response record Type .

Parameters:

responseRecordType - a response record type

Returns:

the response form record

Throws:

NullArgumentException - responseRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(responseRecordType) is false

Compliance:

mandatory - This method must be implemented.