org.osid.voting.batch

Interface BallotBatchFormList

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidList

public interface BallotBatchFormList
extends OsidList

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());
       }
       
                   
       
  

Method Summary

Methods

Modifier and Type	Method and Description
BallotBatchForm	getNextBallotBatchForm() Gets the next BallotBatchForm in this list.
BallotBatchForm[]	getNextBallotBatchForms(long n) Gets the next set of BallotBatchForm elements in this list.

Methods inherited from interface org.osid.OsidList

available, hasNext, skip

Methods inherited from interface org.osid.binding.java.OsidList

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getNextBallotBatchForm

BallotBatchForm getNextBallotBatchForm()
                                       throws OperationFailedException

Gets the next BallotBatchForm in this list.

Returns:

the next BallotBatchForm in this list. The hasNext() method should be used to test that a next BallotBatchForm is available before calling this method.

Throws:

IllegalStateException - no more elements available in this list

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getNextBallotBatchForms

BallotBatchForm[] getNextBallotBatchForms(long n)
                                          throws OperationFailedException

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

Parameters:

n - the number of BallotBatchForm elements requested which must be less than or equal to available()

Returns:

an array of BallotBatchForm elements. The length of the array is less than or equal to the number specified.

Throws:

IllegalStateException - no more elements available in this list

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.