org.osid.mapping.path

Interface SpeedZoneList

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidList

public interface SpeedZoneList
extends OsidList

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());
       }
       
                   
       
  

Method Summary

Methods

Modifier and Type	Method and Description
SpeedZone	getNextSpeedZone() Gets the next SpeedZone in this list.
SpeedZone[]	getNextSpeedZones(long n) Gets the next set of SpeedZone elements in this list.

Methods inherited from interface org.osid.OsidList

available, hasNext, skip

Methods inherited from interface org.osid.binding.java.OsidList

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getNextSpeedZone

SpeedZone getNextSpeedZone()
                           throws OperationFailedException

Gets the next SpeedZone in this list.

Returns:

the next SpeedZone in this list. The hasNext() method should be used to test that a next SpeedZone is available before calling this method.

Throws:

IllegalStateException - no more elements available in this list

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getNextSpeedZones

SpeedZone[] getNextSpeedZones(long n)
                              throws OperationFailedException

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

Parameters:

n - the number of SpeedZone elements requested which must be less than or equal to available()

Returns:

an array of SpeedZone elements. The length of the array is less than or equal to the number specified.

Throws:

IllegalStateException - no more elements available in this list

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.