Interface PostForm

All Superinterfaces:

Extensible, Identifiable, OsidAggregateableForm, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, Suppliable

public interface PostForm
extends OsidObjectForm, OsidAggregateableForm

This is the form for creating and updating Posts. Like all OsidForms, 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.

Method Summary

Modifier and Type	Method	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.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type.

Methods inherited from interface Identifiable

getId, isCurrent

Modifier and Type	Method	Description
Id	getId()	Gets the Id associated with this instance of this OSID object.
boolean	isCurrent()	Tests to see if the last method invoked retrieved up-to-date data.

Methods inherited from interface OsidExtensibleForm

getRequiredRecordTypes

Modifier and Type	Method	Description
TypeList	getRequiredRecordTypes()	Gets the minimum required record types for successful submission of this OsidForm.

Methods inherited from interface OsidForm

getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale

Modifier and Type	Method	Description
Locale	getDefaultLocale()	Gets a default locale for the form.
Metadata[]	getInvalidMetadata()	Gets a list of metadata for the elements in this form which are not valid.
Metadata	getJournalCommentMetadata()	Gets the metadata for the comment corresponding to this form submission.
LocaleList	getLocales()	Gets the locales available for this form.
DisplayText[]	getValidationMessages()	Gets text messages corresponding to additional instructions to pass form validation.
boolean	isForUpdate()	Tests if this form is for an update operation.
boolean	isValid()	Tests if this form is in a valid state for submission.
void	setJournalComment(String comment)	Sets a comment.
void	setLocale(Type languageType, Type scriptType)	Specifies a language and script type for the form.

Methods inherited from interface OsidObjectForm

clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType

Modifier and Type	Method	Description
void	clearDescription()	Clears the description.
void	clearDisplayName()	Clears the display name.
void	clearGenusType()	Clears the genus type.
Metadata	getDescriptionMetadata()	Gets the metadata for a description.
Metadata	getDisplayNameMetadata()	Gets the metadata for a display name.
Metadata	getGenusTypeMetadata()	Gets the metadata for a genus type.
void	setDescription(String description)	Sets a description.
void	setDisplayName(String displayName)	Sets a display name.
void	setGenusType(Type genusType)	Sets a genus.

Method Details

getFiscalPeriodMetadata

Metadata getFiscalPeriodMetadata()

Gets the metadata for the fiscal period.

Returns:

metadata for the fiscal period

Compliance:

mandatory - This method must be implemented.

setFiscalPeriod

void setFiscalPeriod(Id fiscalPeriodId)

Sets the fiscal period.

Parameters:

fiscalPeriodId - the new fiscal period

Throws:

InvalidArgumentException - fiscalPeriodId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - fiscalPeriodId is null

Compliance:

mandatory - This method must be implemented.

clearFiscalPeriod

void clearFiscalPeriod()

Removes the fiscal period.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getDateMetadata

Metadata getDateMetadata()

Gets the metadata for the date.

Returns:

metadata for the date

Compliance:

mandatory - This method must be implemented.

setDate

void setDate(DateTime date)

Sets the date.

Parameters:

date - the new date

Throws:

InvalidArgumentException - date is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - date is null

Compliance:

mandatory - This method must be implemented.

clearDate

void clearDate()

Removes the date.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getCorrectedPostMetadata

Metadata getCorrectedPostMetadata()

Gets the metadata for the corrected post.

Returns:

metadata for the corrected post

Compliance:

mandatory - This method must be implemented.

setCorrectedPost

void setCorrectedPost(Id postId)

Sets the corrected post.

Parameters:

postId - the new corrected post

Throws:

InvalidArgumentException - postId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - postId is null

Compliance:

mandatory - This method must be implemented.

clearCorrectedPost

void clearCorrectedPost()

Removes the corrected post.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getPostFormRecord

PostFormRecord getPostFormRecord(Type postRecordType)
                          throws OperationFailedException

Gets the PostFormRecord corresponding to the given post record Type.

Parameters:

postRecordType - a post record type

Returns:

the post form record

Throws:

NullArgumentException - postRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(postRecordType) is false

Compliance:

mandatory - This method must be implemented.