public interface Post extends OsidObject, Aggregateable
A Post
is a set of PostEntries
representing a complete accounting transaction.
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.
|
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
Id getFiscalPeriodId()
Id
of the FiscalPeriod.
FiscalPeriod
Id
mandatory
- This method must be implemented. FiscalPeriod getFiscalPeriod() throws OperationFailedException
FiscalPeriod.
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. boolean isPosted()
true
if this has been posted, false
if just lying aroundmandatory
- This method is must be implemented. DateTime getDate()
mandatory
- This method is must be implemented. IdList getPostEntryIds()
Ids
of the PostEntries.
PostEntry
Ids
mandatory
- This method must be implemented. PostEntryList getPostEntries() throws OperationFailedException
PostEntries.
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. boolean isCorrection()
Post
is a correction to a previous post. true
if this post is a correction, false
otherwisemandatory
- This method must be implemented. Id getCorrectedPostId()
Id
of the corrected Post.
Post
Id
IllegalStateException
- isCorrection()
is false
mandatory
- This method must be implemented. Post getCorrectedPost() throws OperationFailedException
Post.
IllegalStateException
- isCorrection()
is false
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. PostRecord getPostRecord(Type postRecordType) throws OperationFailedException
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
.postRecordType
- the type of post record to retrieveNullArgumentException
- postRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(postRecordType)
is false
mandatory
- This method must be implemented.