OSID Logo
OSID Specifications
resourcing package
Version 3.0.0
Release Candidate Preview
Interfaceosid.resourcing.FoundryNodeList
Implementsosid.OsidList
Description

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

                     
                     
                     while (fnl.hasNext()) {
                          FoundryNode node = fnl.getNextFoundryNode();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (fnl.hasNext()) {
                          FoundryNode[] nodes = fnl.getNextFoundryNodes(fnl.available());
                     }
                     
                                 
                     
                
MethodgetNextFoundryNode
Description

Gets the next FoundryNode in this list.

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

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

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