public interface BudgetEntry extends OsidRelationship
A BudgetEntry
for an Account.
Modifier and Type | Method and Description |
---|---|
Account |
getAccount()
Gets the account.
|
Id |
getAccountId()
Gets the account
Id. |
Currency |
getAmount()
Gets the amount of this budget entries.
|
Budget |
getBudget()
Gets the budget.
|
BudgetEntryRecord |
getBudgetEntryRecord(Type budgetEntryRecordType)
Gets the budget entry record corresponding to the given
BudgetEntry record Type. |
Id |
getBudgetId()
Gets the budget
Id. |
boolean |
isDebit()
Tests if the budgeted amount is to be debited or a credited to this
activity.
|
getEndReason, getEndReasonId, hasEndReason
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
getEndDate, getStartDate, isEffective
Id getBudgetId()
Id.
Id
mandatory
- This method must be implemented. Budget getBudget() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. Id getAccountId()
Id.
Id
mandatory
- This method must be implemented. Account getAccount() 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 item amount is a debit,
false
if it is a creditmandatory
- This method must be implemented. BudgetEntryRecord getBudgetEntryRecord(Type budgetEntryRecordType) throws OperationFailedException
BudgetEntry
record Type.
This method is used to
retrieve an object implementing the requested record. The
budgetEntryRecordType
may be the Type
returned
in getRecordTypes()
or any of its parents in a
Type
hierarchy where
hasRecordType(budgetEntryRecordType)
is true
.budgetEntryRecordType
- the type of budget entry record to
retrieveNullArgumentException
- budgetEntryRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(budgetEntryRecordType)
is false
mandatory
- This method must be implemented.