org.osid.financials.budgeting

Interface Budget

All Superinterfaces:

Browsable, Extensible, Identifiable, OsidObject, OsidRelationship, Temporal

public interface Budget
extends OsidRelationship

A Budget.

Method Summary

Methods

Modifier and Type	Method and Description
Activity	getActivity() Gets the activity.
Id	getActivityId() Gets the actvity Id.
BudgetRecord	getBudgetRecord(Type budgetRecordType) Gets the budget record corresponding to the given Budget record Type.
FiscalPeriod	getFiscalPeriod() Gets the FiscalPeriod.
Id	getFiscalPeriodId() Gets the Id of the FiscalPeriod.

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

getActivityId

Id getActivityId()

Gets the actvity Id.

Returns:

the activity Id

Compliance:

mandatory - This method must be implemented.

getActivity

Activity getActivity()
                     throws OperationFailedException

Gets the activity.

Returns:

the activity

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getFiscalPeriodId

Id getFiscalPeriodId()

Gets the Id of the FiscalPeriod.

Returns:

the FiscalPeriod Id

Compliance:

mandatory - This method must be implemented.

getFiscalPeriod

FiscalPeriod getFiscalPeriod()
                             throws OperationFailedException

Gets the FiscalPeriod.

Returns:

the fiscal period

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getBudgetRecord

BudgetRecord getBudgetRecord(Type budgetRecordType)
                             throws OperationFailedException

Gets the budget record corresponding to the given Budget record Type. This method is used to retrieve an object implementing the requested record. The budgetRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(budgetRecordType) is true .

Parameters:

budgetRecordType - the type of budget record to retrieve

Returns:

the budget record

Throws:

NullArgumentException - budgetRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(budgetRecordType) is false

Compliance:

mandatory - This method must be implemented.