OSID Logo
OSID Specifications
financials budgeting package
Version 3.1.0
Interfaceosid.financials.budgeting.BudgetList
Implementsosid.OsidList
Used Byosid.financials.budgeting.BudgetBusinessSession
osid.financials.budgeting.BudgetLookupSession
osid.financials.budgeting.BudgetQuerySession
osid.financials.budgeting.BudgetSearchResults
Description

Like all OsidLists, BudgetList provides a means for accessing Budget elements sequentially either one at a time or many at a time. Examples:

while (bl.hasNext()) {
     Budget budget = bl.getNextBudget();
}
                
or
while (bl.hasNext()) {
     Budget[] budgets = bl.getNextBudgets(bl.available());
}
                
MethodgetNextBudget
Description

Gets the next Budget in this list.

Returnosid.financials.budgeting.Budget the next Budget in this list. The hasNext() method should be used to test that a next Budget is available before calling this method.
ErrorsILLEGAL_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodgetNextBudgets
Description

Gets the next set of Budget elements in this list. The specified amount must be less than or equal to the return from available().

Parameterscardinaln the number of Budget elements requested which must be less than or equal to available()
Returnosid.financials.budgeting.Budget[] an array of Budget elements. The length of the array is less than or equal to the number specified.
ErrorsILLEGAL_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.