OSID Logo
OSID Specifications
mapping package
Version 3.0.0
Release Candidate Preview
Interfaceosid.mapping.MapNodeList
Implementsosid.OsidList
Description

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

                     
                     
                     while (mnl.hasNext()) {
                          MapNode node = mnl.getNextMapNode(Node);
                     }
                     
                                 
                     
                
or
                     
                     
                     while (mnl.hasNext()) {
                          MapNode[] nodes = ml.getNextMapNodes(mnl.available());
                     }
                     
                                 
                     
                
MethodgetNextMapNode
Description

Gets the next MapNode in this list.

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

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

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