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

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

                     
                     
                     while (cl.hasNext()) {
                          Coordinate coordinate = cl.getNextCoordinate();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (cl.hasNext()) {
                          Coordinate[] coordinates = cl.getNextCoordinates(cl.available());
                     }
                     
                                 
                     
                
MethodgetNextCoordinate
Description

Gets the next Coordinate in this list.

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

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

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