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

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

                     
                     
                     while (bcl.hasNext()) {
                          BallotConstrainer constrainer = bcl.getNextBallotConstrainer();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (bcl.hasNext()) {
                          BallotConstrainer[] constrainers = bcl.getNextBallotConstrainers(bcl.available());
                     }
                     
                                 
                     
                
MethodgetNextBallotConstrainer
Description

Gets the next BallotConstrainer in this list.

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

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

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