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

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

                     
                     
                     while (fpl.hasNext()) {
                          FiscalPeriod period = fpl.getNextFiscalPeriod();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (fpl.hasNext()) {
                          FiscalPeriod[] periods = fpl.getNextFiscalPeriods(fpl.available());
                     }
                     
                                 
                     
                
MethodgetNextFiscalPeriod
Description

Gets the next FiscalPeriod in this list.

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

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

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