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

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

                     
                     
                     while (abfl.hasNext()) {
                          AccountBatchForm form = abfl.getNextAccountBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (abfl.hasNext()) {
                          AccountBatchForm[] forms = abfl.getNextAccountBatchForms(abfl.available());
                     }
                     
                                 
                     
                
MethodgetNextAccountBatchForm
Description

Gets the next AccountBatchForm in this list.

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

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

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