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

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

                     
                     
                     while (lnl.hasNext()) {
                          LocationNode locationNode = lnl.getNextLocationNode();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (lnl.hasNext()) {
                          LocationNode[] locationNodes = lnl.getNextLocationNodes(lnl.available());
                     }
                     
                                 
                     
                
MethodgetNextLocationNode
Description

Gets the next LocationNode in this list.

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

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

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