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

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

                     
                     
                     while (fpbfl.hasNext()) {
                          FiscalPeriodBatchForm form = fpbfl.getNextFiscalPeriodBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (fpbfl.hasNext()) {
                          FiscalPeriodBatchForm[] forms = fpbfl.getNextFiscalPeriodBatchForms(fpbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextFiscalPeriodBatchForm
Description

Gets the next FiscalPeriodBatchForm in this list.

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

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

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