OSID Logo
OSID Specifications
financials budgeting package
Version 3.1.0
Interfaceosid.financials.budgeting.BudgetEntry
Implementsosid.OsidRelationship
Used Byosid.financials.budgeting.BudgetEntryAdminSession
osid.financials.budgeting.BudgetEntryList
osid.financials.budgeting.BudgetEntryLookupSession
Description

A BudgetEntry for an Account.

MethodgetBudgetId
Description

Gets the budget Id.

Returnosid.id.Id the budget Id
Compliancemandatory This method must be implemented.
MethodgetBudget
Description

Gets the budget.

Returnosid.financials.budgeting.Budget the budget
ErrorsOPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodgetAccountId
Description

Gets the account Id.

Returnosid.id.Id the account Id
Compliancemandatory This method must be implemented.
MethodgetAccount
Description

Gets the account.

Returnosid.financials.Account the account
ErrorsOPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodgetAmount
Description

Gets the amount of this budget entries.

Returnosid.financials.Currency the amount
Compliancemandatory This method must be implemented.
MethodisDebit
Description

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

Returnboolean true if this item amount is a debit, false if it is a credit
Compliancemandatory This method must be implemented.
MethodgetBudgetEntryRecord
Description

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.

Parametersosid.type.TypebudgetEntryRecordType the type of budget entry record to retrieve
Returnosid.financials.budgeting.records.BudgetEntryRecord the budget entry record
ErrorsNULL_ARGUMENT budgetEntryRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(budgetEntryRecordType) is false
Compliancemandatory This method must be implemented.