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

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

                     
                     
                     while (cl.hasNext()) {
                          Candidate candidate = cl.getNextCandidate();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (cl.hasNext()) {
                          Candidate[] candidates = cl.getNextCandidates(cl.available());
                     }
                     
                                 
                     
                
MethodgetNextCandidate
Description

Gets the next Candidate in this list.

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

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

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