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

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

                     
                     
                     while (gl.hasNext()) {
                          Graph graph = gl.getNextGraph();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (gl.hasNext()) {
                          Graph[] graphs = gl.getNextGraphs(gl.available());
                     }
                     
                                 
                     
                
MethodgetNextGraph
Description

Gets the next Graph in this list.

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

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

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