org.osid.financials.posting

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 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.

Method Summary

Methods

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.

Methods inherited from interface org.osid.OsidObjectForm

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

Methods inherited from interface org.osid.OsidExtensibleForm

getRequiredRecordTypes

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidForm

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

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Method Detail

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.