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

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

                     
                     
                     while (pbfl.hasNext()) {
                          PollsBatchForm form = pbfl.getNextPollsBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (pbfl.hasNext()) {
                          PollsBatchForm[] forms = pbfl.getNextPollsBatchForms(pbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextPollsBatchForm
Description

Gets the next PollsBatchForm in this list.

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

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

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