org.osid.communication

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

Methods

Modifier and Type	Method and 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, java.lang.Object value) Sets a value for a given field.

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

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,
            java.lang.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.