OSID Logo
OSID Specifications
financials budgeting package
Version 3.0.0
Release Candidate Preview
Interfaceosid.financials.budgeting.BudgetEntry
Implementsosid.OsidRelationship
Description

A BudgetEntry for an Account.

MethodgetBudgetId
Description

Gets the budget Id.

Returnosid.id.Idthe budget Id
CompliancemandatoryThis method must be implemented.
MethodgetBudget
Description

Gets the budget.

Returnosid.financials.budgeting.Budgetthe budget
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetAccountId
Description

Gets the account Id.

Returnosid.id.Idthe account Id
CompliancemandatoryThis method must be implemented.
MethodgetAccount
Description

Gets the account.

Returnosid.financials.Accountthe account
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetAmount
Description

Gets the amount of this budget entries.

Returnosid.financials.Currencythe amount
CompliancemandatoryThis 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
CompliancemandatoryThis 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.TypebudgetEntryRecordTypethe type of budget entry record to retrieve
Returnosid.financials.budgeting.records.BudgetEntryRecordthe budget entry record
ErrorsNULL_ARGUMENT budgetEntryRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(budgetEntryRecordType) is false
CompliancemandatoryThis method must be implemented.