OSID Logo
OSID Specifications
billing package
Version 3.1.0
Interfaceosid.billing.PeriodList
Implementsosid.OsidList
Used Byosid.billing.PeriodBusinessSession
osid.billing.PeriodLookupSession
osid.billing.PeriodQuerySession
osid.billing.PeriodSearchResults
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.Period the next Period in this list. The hasNext() method should be used to test that a next Period is available before calling this method.
ErrorsILLEGAL_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This 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().

Parameterscardinaln the 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_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.