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

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

                     
                     
                     while (sul.hasNext()) {
                          SpatialUnit unit = sul.getNextSpatialUnit();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (sul.hasNext()) {
                          SpatialUnit[] units = sul.getNextSpatialUnits(sul.available());
                     }
                     
                                 
                     
                
MethodgetNextSpatialUnit
Description

Gets the next SpatialUnit in this list.

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

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

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