org.osid.voting

Interface RaceList

All Superinterfaces:

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

public interface RaceList
extends OsidList

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

       
       
       while (rl.hasNext()) {
            Race race = rl.getNextRace();
       }
       
                   
       
  

or

       
       
       while (rl.hasNext()) {
            Race[] races = rl.getNextRaces(rl.available());
       }
       
                   
       
  

Method Summary

Methods

Modifier and Type	Method and Description
Race	getNextRace() Gets the next Race in this list.
Race[]	getNextRaces(long n) Gets the next set of Races in this list which must be less than or equal to the return from available().

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

getNextRace

Race getNextRace()
                 throws OperationFailedException

Gets the next Race in this list.

Returns:

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

getNextRaces

Race[] getNextRaces(long n)
                    throws OperationFailedException

Gets the next set of Races in this list which must be less than or equal to the return from available().

Parameters:

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

Returns:

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