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

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

                     
                     
                     while (bbfl.hasNext()) {
                          BallotBatchForm form = bbfl.getNextBallotBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (bbfl.hasNext()) {
                          BallotBatchForm[] forms = bbfl.getNextBallotBatchForms(bbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextBallotBatchForm
Description

Gets the next BallotBatchForm in this list.

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

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

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