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

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

                     
                     
                     while (rbfl.hasNext()) {
                          RaceBatchForm form = rbfl.getNextRaceBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (rbfl.hasNext()) {
                          RaceBatchForm[] forms = rbfl.getNextRaceBatchForms(rbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextRaceBatchForm
Description

Gets the next RaceBatchForm in this list.

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

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

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