OSID Logo
OSID Specifications
metering package
Version 3.1.0
Interfaceosid.metering.UtilityNodeList
Implementsosid.OsidList
Used Byosid.metering.UtilityNode
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.UtilityNode the next UtilityNode in this list. The hasNext() method should be used to test that a next UtilityNode 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.
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().

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