OSID Logo
OSID Specifications
voting batch package
Version 3.1.0
Interfaceosid.voting.batch.VotePeerList
Implementsosid.OsidList
Description

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

while (vpl.hasNext()) {
     VotePeer peer = vpl.getNextVotePeer();
}
                
or
while (vpl.hasNext()) {
     VotePeer[] peers = vpl.getNextVotePeers(vpl.available());
}
                
MethodgetNextVotePeer
Description

Gets the next VotePeer in this list.

Returnosid.voting.batch.VotePeer the next VotePeer in this list. The hasNext() method should be used to test that a next VotePeer 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.
MethodgetNextVotePeers
Description

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

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