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.
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.
|
clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType
getRequiredRecordTypes
getRecordTypes, hasRecordType
getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale
getId, isCurrent
clearEndDate, clearStartDate, getEndDateMetadata, getStartDateMetadata, setEndDate, setStartDate
Metadata getAffirmativeMetadata()
mandatory
- This method must be implemented. void setAffirmative(boolean affirmative)
affirmative
- true
is a posiitve response,
false
if a negative responseInvalidArgumentException
- affirmative
is invalidNoAccessException
- Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. void clearAffirmative()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. ResponseFormRecord getResponseFormRecord(Type responseRecordType) throws OperationFailedException
ResponseFormRecord
corresponding to the given
response record Type.
responseRecordType
- a response record typeNullArgumentException
- responseRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(responseRecordType)
is false
mandatory
- This method must be implemented.