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

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

                     
                     
                     while (bbfl.hasNext()) {
                          BudgetEntryBatchForm form = bbfl.getNextBudgetEntryBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (bbfl.hasNext()) {
                          BudgetEntryBatchForm[] forms = bbfl.getNextBudgetEntryBatchForms(bbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextBudgetEntryBatchForm
Description

Gets the next BudgetEntryBatchForm in this list.

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

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

Parameterscardinalnthe number of BudgetEntryBatchForm elements requested which must be less than or equal to available()
Returnosid.financials.budgeting.batch.BudgetEntryBatchForm[]an array of BudgetEntryBatchForm 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.