OSID Logo
OSID Specifications
voting package
Version 3.1.0
Interfaceosid.voting.VoteList
Implementsosid.OsidList
Used Byosid.voting.VoteLookupSession
osid.voting.VotePollsSession
osid.voting.VoteQuerySession
osid.voting.VoteSearchResults
osid.voting.VotingSession
osid.voting.rules.VoteEnablerRuleLookupSession
Description

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

while (vl.hasNext()) {
     Vote vote = vl.getNextVote();
}
                
or
while (vl.hasNext()) {
     Vote[] votes = vl.getNextVotes(vl.available());
}
                
MethodgetNextVote
Description

Gets the next Vote in this list.

Returnosid.voting.Vote the next Vote in this list. The hasNext() method should be used to test that a next Vote is available before calling this method.
ErrorsILLEGAL_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodgetNextVotes
Description

Gets the next set of Vote elements in this list which must be less than or equal to the number returned from available().

Parameterscardinaln the number of Vote elements requested which should be less than or equal to available()
Returnosid.voting.Vote[] an array of Vote elements. The length of the array is less than or equal to the number specified.
ErrorsILLEGAL_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.