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

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

                     
                     
                     while (rcl.hasNext()) {
                          RaceConstrainer constrainer = rcl.getNextRaceConstrainer();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (rcl.hasNext()) {
                          RaceConstrainer[] constrainers = rcl.getNextRaceConstrainers(rcl.available());
                     }
                     
                                 
                     
                
MethodgetNextRaceConstrainer
Description

Gets the next RaceConstrainer in this list.

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

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

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