org.osid.mapping.path.batch

Interface SpeedZoneBatchFormList

All Superinterfaces:

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

public interface SpeedZoneBatchFormList
extends OsidList

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

       
       
       while (sbfl.hasNext()) {
            SpeedZoneBatchForm form = sbfl.getNextSpeedZoneBatchForm();
       }
       
                   
       
  

or

       
       
       while (sbfl.hasNext()) {
            SpeedZoneBatchForm[] forms = sbfl.getNextSpeedZoneBatchForms(sbfl.available());
       }
       
                   
       
  

Method Summary

Methods

Modifier and Type	Method and Description
SpeedZoneBatchForm	getNextSpeedZoneBatchForm() Gets the next SpeedZoneBatchForm in this list.
SpeedZoneBatchForm[]	getNextSpeedZoneBatchForms(long n) Gets the next set of SpeedZoneBatchForm 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

getNextSpeedZoneBatchForm

SpeedZoneBatchForm getNextSpeedZoneBatchForm()
                                             throws OperationFailedException

Gets the next SpeedZoneBatchForm in this list.

Returns:

the next SpeedZoneBatchForm in this list. The hasNext() method should be used to test that a next SpeedZoneBatchForm 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.

getNextSpeedZoneBatchForms

SpeedZoneBatchForm[] getNextSpeedZoneBatchForms(long n)
                                                throws OperationFailedException

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

Parameters:

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

Returns:

an array of SpeedZoneBatchForm 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.