public interface PostForm extends OsidObjectForm
This is the form for creating and updating Posts.
Like
all OsidForm
objects, various data elements may be set here
for use in the create and update methods in the PostAdminSession.
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 |
clearPoster()
Clears the poster.
|
void |
clearSubjectLine()
Clears the subject line.
|
void |
clearText()
Clears the text.
|
void |
clearTimestamp()
Clears the poster.
|
Metadata |
getPosterMetadata()
Gets the metadata for the poster.
|
PostFormRecord |
getPostFormRecord(Type postRecordType)
Gets the
PostFormRecord corresponding to the given post
record Type. |
Metadata |
getSubjectLineMetadata()
Gets the metadata for the subject line.
|
Metadata |
getTextMetadata()
Gets the metadata for the text.
|
Metadata |
getTimestampMetadata()
Gets the metadata for the timestamp.
|
void |
setPoster(Id resourceId)
Sets the poster.
|
void |
setSubjectLine(java.lang.String subjectLine)
Sets the subject line.
|
void |
setText(java.lang.String text)
Sets the text.
|
void |
setTimestamp(DateTime timestamp)
Sets the timestamp.
|
clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType
getRequiredRecordTypes
getRecordTypes, hasRecordType
getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale
getId, isCurrent
Metadata getTimestampMetadata()
mandatory
- This method must be implemented. void setTimestamp(DateTime timestamp)
timestamp
- the new timestampInvalidArgumentException
- timestamp
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- timestamp
is
null
mandatory
- This method must be implemented. void clearTimestamp()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getPosterMetadata()
mandatory
- This method must be implemented. void setPoster(Id resourceId)
resourceId
- the new posterInvalidArgumentException
- resourceId
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- resourceId
is
null
mandatory
- This method must be implemented. void clearPoster()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getSubjectLineMetadata()
mandatory
- This method must be implemented. void setSubjectLine(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. PostFormRecord getPostFormRecord(Type postRecordType) throws OperationFailedException
PostFormRecord
corresponding to the given post
record Type.
postRecordType
- the post record typeNullArgumentException
- postRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(postRecordType)
is false
mandatory
- This method must be implemented.