OSID Logo
OSID Specifications
financials budgeting package
Version 3.0.0
Release Candidate Preview
Interfaceosid.financials.budgeting.BudgetEntryList
Implementsosid.OsidList
Description

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

                     
                     
                     while (bel.hasNext()) {
                          BudgetEntry budget entry = bel.getNextBudgetEntry();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (bel.hasNext()) {
                          BudgetEntry[] entries = bel.getNextBudgetEntries(bel.available());
                     }
                     
                                 
                     
                
MethodgetNextBudgetEntry
Description

Gets the next BudgetEntry in this list.

Returnosid.financials.budgeting.BudgetEntrythe next BudgetEntry in this list. The hasNext() method should be used to test that a next BudgetEntry is available before calling this method.
ErrorsILLEGAL_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetNextBudgetEntries
Description

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

Parameterscardinalnthe number of BudgetEntry elements requested which must be less than or equal to available()
Returnosid.financials.budgeting.BudgetEntry[]an array of BudgetEntry elements. The length of the array is less than or equal to the number specified.
ErrorsILLEGAL_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.