OSID Logo
OSID Specifications
billing package
Version 3.0.0
Release Candidate Preview
Interfaceosid.billing.PeriodList
Implementsosid.OsidList
Description

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

                     
                     
                     while (pl.hasNext()) {
                          Period period = pl.getNextPeriod();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (pl.hasNext()) {
                          Period[] periods = pl.getNextPeriods(pl.available());
                     }
                     
                                 
                     
                
MethodgetNextPeriod
Description

Gets the next Period in this list.

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

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

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