OSID Logo
OSID Specifications
metering package
Version 3.0.0
Release Candidate Preview
Interfaceosid.metering.StatisticList
Implementsosid.OsidList
Description

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

                     
                     
                     while (sl.hasNext()) {
                          Statistic stat = sl.getNextStatistic();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (sl.hasNext()) {
                          Statistic[] stats = sl.getNextStatistics(sl.available());
                     }
                     
                                 
                     
                
MethodgetNextStatistic
Description

Gets the next Statistic in this list.

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

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

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