OSID Logo
OSID Specifications
topology package
Version 3.0.0
Release Candidate Preview
Interfaceosid.topology.GraphNodeList
Implementsosid.OsidList
Description

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

                     
                     
                     while (gnl.hasNext()) {
                          GraphNode node = gnl.getNextGraphNode();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (gnl.hasNext()) {
                          GraphNode[] nodes = gnl.getNextGraphNodes(gnl.available());
                     }
                     
                                 
                     
                
MethodgetNextGraphNode
Description

Gets the next GraphNode in this list.

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

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

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