org.osid.inquiry

Interface ResponseForm

All Superinterfaces:

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

All Known Subinterfaces:

ResponseBatchForm

public interface ResponseForm
extends OsidRelationshipForm

This is the form for creating and updating responses. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the ResponseAdminSession. 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	clearAffirmative() Removes the affirmative flag.
Metadata	getAffirmativeMetadata() Gets the metadata for the affirmative flag.
ResponseFormRecord	getResponseFormRecord(Type responseRecordType) Gets the ResponseFormRecord corresponding to the given response record Type.
void	setAffirmative(boolean affirmative) Sets the affirmative flag.

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

Methods inherited from interface org.osid.OsidTemporalForm

clearEndDate, clearStartDate, getEndDateMetadata, getStartDateMetadata, setEndDate, setStartDate

Method Detail

getAffirmativeMetadata

Metadata getAffirmativeMetadata()

Gets the metadata for the affirmative flag.

Returns:

metadata for the affirmative flag

Compliance:

mandatory - This method must be implemented.

setAffirmative

void setAffirmative(boolean affirmative)

Sets the affirmative flag.

Parameters:

affirmative - true is a posiitve response, false if a negative response

Throws:

InvalidArgumentException - affirmative is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearAffirmative

void clearAffirmative()

Removes the affirmative flag.

Throws:

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

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.