org.osid.financials.budgeting

Interface BudgetEntry

All Superinterfaces:

Browsable, Extensible, Identifiable, OsidObject, OsidRelationship, Temporal

public interface BudgetEntry
extends OsidRelationship

A BudgetEntry for an Account.

Method Summary

Methods

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.

Methods inherited from interface org.osid.OsidRelationship

getEndReason, getEndReasonId, hasEndReason

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

Methods inherited from interface org.osid.Temporal

getEndDate, getStartDate, isEffective

Method Detail

getBudgetId

Id getBudgetId()

Gets the budget Id.

Returns:

the budget Id

Compliance:

mandatory - This method must be implemented.

getBudget

Budget getBudget()
                 throws OperationFailedException

Gets the budget.

Returns:

the budget

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getAccountId

Id getAccountId()

Gets the account Id.

Returns:

the account Id

Compliance:

mandatory - This method must be implemented.

getAccount

Account getAccount()
                   throws OperationFailedException

Gets the account.

Returns:

the account

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getAmount

Currency getAmount()

Gets the amount of this budget entries.

Returns:

the amount

Compliance:

mandatory - This method must be implemented.

isDebit

boolean isDebit()

Tests if the budgeted amount is to be debited or a credited to this activity.

Returns:

true if this item amount is a debit, false if it is a credit

Compliance:

mandatory - This method must be implemented.

getBudgetEntryRecord

BudgetEntryRecord getBudgetEntryRecord(Type budgetEntryRecordType)
                                       throws OperationFailedException

Gets the budget entry record corresponding to the given 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 .

Parameters:

budgetEntryRecordType - the type of budget entry record to retrieve

Returns:

the budget entry record

Throws:

NullArgumentException - budgetEntryRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(budgetEntryRecordType) is false

Compliance:

mandatory - This method must be implemented.