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

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

                     
                     
                     while (bl.hasNext()) {
                          Ballot ballot = bl.getNextBallot();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (bl.hasNext()) {
                          Ballot[] ballots = bl.getNextBallots(bl.available());
                     }
                     
                                 
                     
                
MethodgetNextBallot
Description

Gets the next Ballot in this list.

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

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

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