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

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

                     
                     
                     while (rcel.hasNext()) {
                          RaceConstrainerEnabler enabler = rcel.getNextRaceConstrainerEnabler();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (rcel.hasNext()) {
                          RaceConstrainerEnabler[] enablers = rcel.getNextRaceConstrainerEnablers(rcel.available());
                     }
                     
                                 
                     
                
MethodgetNextRaceConstrainerEnabler
Description

Gets the next RaceConstrainerEnabler in this list.

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

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

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