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

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

while (cpl.hasNext()) {
     CandidatePeer peer = cpl.getNextCandidatePeer();
}
                
or
while (cpl.hasNext()) {
     CandidatePeer[] peers = cpl.getNextCandidatePeers(cpl.available());
}
                
MethodgetNextCandidatePeer
Description

Gets the next CandidatePeer in this list.

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

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

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