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

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

                     
                     
                     while (szl.hasNext()) {
                          SpeedZone zone = szl.getNextSpeedZone();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (szl.hasNext()) {
                          SSpeedZone[] zones = szl.getNextSpeedZones(szl.available());
                     }
                     
                                 
                     
                
MethodgetNextSpeedZone
Description

Gets the next SpeedZone in this list.

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

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

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