public interface ReplyForm extends OsidObjectForm, OsidContainableForm, OsidSubjugateableForm
This is the form for creating and updating Reply
objects. Like all OsidForm
objects, various data elements
may be set here for use in the create and update methods in the
ReplyAdminSession.
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 |
clearSubjectLine()
Clears the subject line.
|
void |
clearText()
Clears the text.
|
ReplyFormRecord |
getReplyFormRecord(Type replyRecordType)
Gets the
ReplyFormRecord corresponding to the given
reply record Type. |
Metadata |
getSubjectLineMetadata()
Gets the metadata for the subject line.
|
Metadata |
getTextMetadata()
Gets the metadata for the text.
|
void |
setText(java.lang.String text)
Sets the text.
|
void |
setTimestamp(java.lang.String subjectLine)
Sets the subject line.
|
clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType
getRequiredRecordTypes
getRecordTypes, hasRecordType
clearSequestered, getSequesteredMetadata, setSequestered
getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale
getId, isCurrent
Metadata getSubjectLineMetadata()
mandatory
- This method must be implemented. void setTimestamp(java.lang.String subjectLine)
subjectLine
- the new subject lineInvalidArgumentException
- subjectLine
is invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- subjectLine
is
null
mandatory
- This method must be implemented. void clearSubjectLine()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getTextMetadata()
mandatory
- This method must be implemented. void setText(java.lang.String text)
text
- the new textInvalidArgumentException
- text
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- text
is
null
mandatory
- This method must be implemented. void clearText()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. ReplyFormRecord getReplyFormRecord(Type replyRecordType) throws OperationFailedException
ReplyFormRecord
corresponding to the given
reply record Type.
replyRecordType
- the reply record typeNullArgumentException
- replyRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(replyRecordType)
is false
mandatory
- This method must be implemented.