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

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

                     
                     
                     while (bbfl.hasNext()) {
                          BudgetBatchForm form = bbfl.getNextBudgetBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (bbfl.hasNext()) {
                          BudgetBatchForm[] forms = bbfl.getNextBudgetBatchForms(bbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextBudgetBatchForm
Description

Gets the next BudgetBatchForm in this list.

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

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

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