org.osid.financials.posting

Interface Post

All Superinterfaces:

Aggregateable, Browsable, Extensible, Identifiable, OsidObject

public interface Post
extends OsidObject, Aggregateable

A Post is a set of PostEntries representing a complete accounting transaction.

Method Summary

Methods

Modifier and Type	Method and Description
Post	getCorrectedPost() Gets the corrected Post.
Id	getCorrectedPostId() Gets the Id of the corrected Post.
DateTime	getDate() Gets the posting date.
FiscalPeriod	getFiscalPeriod() Gets the FiscalPeriod.
Id	getFiscalPeriodId() Gets the Id of the FiscalPeriod.
PostEntryList	getPostEntries() Gets the PostEntries.
IdList	getPostEntryIds() Gets the Ids of the PostEntries.
PostRecord	getPostRecord(Type postRecordType) Gets the post record corresponding to the given Post record Type.
boolean	isCorrection() Tests if this Post is a correction to a previous post.
boolean	isPosted() Tests if this has been posted.

Methods inherited from interface org.osid.OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Method Detail

getFiscalPeriodId

Id getFiscalPeriodId()

Gets the Id of the FiscalPeriod.

Returns:

the FiscalPeriod Id

Compliance:

mandatory - This method must be implemented.

getFiscalPeriod

FiscalPeriod getFiscalPeriod()
                             throws OperationFailedException

Gets the FiscalPeriod.

Returns:

the fiscal period

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

isPosted

boolean isPosted()

Tests if this has been posted.

Returns:

true if this has been posted, false if just lying around

Compliance:

mandatory - This method is must be implemented.

getDate

DateTime getDate()

Gets the posting date.

Returns:

the posting date

Compliance:

mandatory - This method is must be implemented.

getPostEntryIds

IdList getPostEntryIds()

Gets the Ids of the PostEntries.

Returns:

the PostEntry Ids

Compliance:

mandatory - This method must be implemented.

getPostEntries

PostEntryList getPostEntries()
                             throws OperationFailedException

Gets the PostEntries.

Returns:

the post entries

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

isCorrection

boolean isCorrection()

Tests if this Post is a correction to a previous post.

Returns:

true if this post is a correction, false otherwise

Compliance:

mandatory - This method must be implemented.

getCorrectedPostId

Id getCorrectedPostId()

Gets the Id of the corrected Post.

Returns:

the corrected Post Id

Throws:

IllegalStateException - isCorrection() is false

Compliance:

mandatory - This method must be implemented.

getCorrectedPost

Post getCorrectedPost()
                      throws OperationFailedException

Gets the corrected Post.

Returns:

the corrected post

Throws:

IllegalStateException - isCorrection() is false

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getPostRecord

PostRecord getPostRecord(Type postRecordType)
                         throws OperationFailedException

Gets the post record corresponding to the given Post record Type. This method is used to retrieve an object implementing the requested record. The postRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(postRecordType) is true .

Parameters:

postRecordType - the type of post record to retrieve

Returns:

the post record

Throws:

NullArgumentException - postRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(postRecordType) is false

Compliance:

mandatory - This method must be implemented.