OSID Logo
OSID Specifications
voting package
Version 3.0.0
Release Candidate Preview
Interfaceosid.voting.RaceList
Implementsosid.OsidList
Description

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

Gets the next Race in this list.

Returnosid.voting.Racethe next Race in this list. The hasNext() method should be used to test that a next Race is available before calling this method.
ErrorsILLEGAL_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetNextRaces
Description

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

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