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

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

                     
                     
                     while (bbfl.hasNext()) {
                          BusinessBatchForm form = bbfl.getNextBusinessBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (bbfl.hasNext()) {
                          BusinessBatchForm[] forms = bbfl.getNextBusinessBatchForms(bbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextBusinessBatchForm
Description

Gets the next BusinessBatchForm in this list.

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

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

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