org.osid.voting.batch

Interface VoteBatchFormList

All Superinterfaces:

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

public interface VoteBatchFormList
extends OsidList

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

Method Summary

Methods

Modifier and Type	Method and Description
VoteBatchForm	getNextVoteBatchForm() Gets the next VoteBatchForm in this list.
VoteBatchForm[]	getNextVoteBatchForms(long n) Gets the next set of VoteBatchForm 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

getNextVoteBatchForm

VoteBatchForm getNextVoteBatchForm()
                                   throws OperationFailedException

Gets the next VoteBatchForm in this list.

Returns:

the next VoteBatchForm in this list. The hasNext() method should be used to test that a next VoteBatchForm 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.

getNextVoteBatchForms

VoteBatchForm[] getNextVoteBatchForms(long n)
                                      throws OperationFailedException

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

Parameters:

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

Returns:

an array of VoteBatchForm 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.