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

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

                     
                     
                     while (vbfl.hasNext()) {
                          VoteBatchForm form = vbfl.getNextVoteBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (vbfl.hasNext()) {
                          VoteBatchForm[] forms = vbfl.getNextVoteBatchForms(vbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextVoteBatchForm
Description

Gets the next VoteBatchForm in this list.

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

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

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