OSID Logo
OSID Specifications
metering package
Version 3.1.0
Interfaceosid.metering.UtilityList
Implementsosid.OsidList
Used Byosid.metering.MeterUtilitySession
osid.metering.UtilityHierarchySession
osid.metering.UtilityLookupSession
osid.metering.UtilityQuerySession
osid.metering.UtilitySearchResults
Description

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

while (ul.hasNext()) {
     Utility utility = ul.getNextUtility();
}
                
or
while (ul.hasNext()) {
     Utility[] utilities = ul.getNextUtilities(ul.available());
}
                
MethodgetNextUtility
Description

Gets the next Utility in this list.

Returnosid.metering.Utility the next Utility in this list. The hasNext() method should be used to test that a next Utility 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.
MethodgetNextUtilities
Description

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

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