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

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

                     
                     
                     while (unl.hasNext()) {
                          UtilityNode node = unl.getNextUtilityNode();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (unl.hasNext()) {
                          UtilityNode[] nodes = unl.getNextUtilityNodes(unl.available());
                     }
                     
                                 
                     
                
MethodgetNextUtilityNode
Description

Gets the next UtilityNode in this list.

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

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

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