OSID Logo
OSID Specifications
hierarchy package
Version 3.1.0
Interfaceosid.hierarchy.NodeList
Implementsosid.OsidList
Used Byosid.hierarchy.Node
Description

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

while (nl.hasNext()) {
     Node node = nl.getNextNode();
}
                
or
while (nl.hasNext()) {
     Node[] nodes = nl.getNextNodes(nl.available());
}
                
MethodgetNextNode
Description

Gets the next Node in this list.

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

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

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