public interface PostEntry extends OsidObject, Subjugateable
A PostEntry
is a debit or a credit made to an
Account
and Activity.
Modifier and Type | Method and Description |
---|---|
Account |
getAccount()
Gets the G/L account to which this entry applies.
|
Id |
getAccountId()
Gets the G/L account
Id to which this entry applies. |
Activity |
getActivity()
Gets the financial activity to which this entry applies.
|
Id |
getActivityId()
Gets the financial activity
Id to which this entry
applies. |
Currency |
getAmount()
Gets the amount.
|
Post |
getPost()
Gets the post to which this entry belongs.
|
PostEntryRecord |
getPostEntryRecord(Type postEntryRecordType)
Gets the post entry record corresponding to the given
PostEntry
record Type. |
Id |
getPostId()
Gets the post
Id to which this entry belongs. |
boolean |
isDebit()
Tests if the amount is a debit or a credit.
|
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
Id getPostId()
Id
to which this entry belongs. Id
mandatory
- This method must be implemented. Post getPost() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. Id getAccountId()
Id
to which this entry applies. Id
mandatory
- This method must be implemented. Account getAccount() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. Id getActivityId()
Id
to which this entry
applies. Id
mandatory
- This method must be implemented. Activity getActivity() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. Currency getAmount()
mandatory
- This method must be implemented. boolean isDebit()
true
if this entry amount is a debit,
false
if it is a creditmandatory
- This method must be implemented. PostEntryRecord getPostEntryRecord(Type postEntryRecordType) throws OperationFailedException
PostEntry
record Type.
This method is used to retrieve an
object implementing the requested record. The
postEntryRecordType
may be the Type
returned in
getRecordTypes()
or any of its parents in a Type
hierarchy where hasRecordType(postEntryRecordType)
is true
.postEntryRecordType
- the type of post entry record to retrieveNullArgumentException
- postEntryRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(postEntryRecordType)
is false
mandatory
- This method must be implemented.