org.osid.voting

Interface RaceResultList

All Superinterfaces:

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

public interface RaceResultList
extends OsidList

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

       
       
       while (rl.hasNext()) {
            RaceResult result = rl.getNextRaceResult();
       }
       
                   
       
  

or

       
       
       while (rl.hasNext()) {
            RaceResult[] results = rl.getNextRaceResults(rl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextRaceResult

RaceResult getNextRaceResult()
                             throws OperationFailedException

Gets the next RaceResult in this list.

Returns:

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

getNextRaceResults

RaceResult[] getNextRaceResults(long n)
                                throws OperationFailedException

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

Parameters:

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

Returns:

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