public interface PostForm extends OsidObjectForm, OsidAggregateableForm
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 |
clearCorrectedPost()
Removes the corrected post.
|
void |
clearDate()
Removes the date.
|
void |
clearFiscalPeriod()
Removes the fiscal period.
|
Metadata |
getCorrectedPostMetadata()
Gets the metadata for the corrected post.
|
Metadata |
getDateMetadata()
Gets the metadata for the date.
|
Metadata |
getFiscalPeriodMetadata()
Gets the metadata for the fiscal period.
|
PostFormRecord |
getPostFormRecord(Type postRecordType)
Gets the
PostFormRecord corresponding to the given post
record Type. |
void |
setCorrectedPost(Id postId)
Sets the corrected post.
|
void |
setDate(DateTime date)
Sets the date.
|
void |
setFiscalPeriod(Id fiscalPeriodId)
Sets the fiscal period.
|
clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType
getRequiredRecordTypes
getRecordTypes, hasRecordType
getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale
getId, isCurrent
Metadata getFiscalPeriodMetadata()
mandatory
- This method must be implemented. void setFiscalPeriod(Id fiscalPeriodId)
fiscalPeriodId
- the new fiscal periodInvalidArgumentException
- fiscalPeriodId
is invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- fiscalPeriodId
is null
mandatory
- This method must be implemented. void clearFiscalPeriod()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getDateMetadata()
mandatory
- This method must be implemented. void setDate(DateTime date)
date
- the new dateInvalidArgumentException
- date
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- date
is
null
mandatory
- This method must be implemented. void clearDate()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getCorrectedPostMetadata()
mandatory
- This method must be implemented. void setCorrectedPost(Id postId)
postId
- the new corrected postInvalidArgumentException
- postId
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- postId
is
null
mandatory
- This method must be implemented. void clearCorrectedPost()
NoAccessException
- Metadata.isRequired()
is true
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
- a post record typeNullArgumentException
- postRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(postRecordType)
is false
mandatory
- This method must be implemented.