org.osid.voting.batch

Interface RaceBatchFormList

All Superinterfaces:

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

public interface RaceBatchFormList
extends OsidList

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

       
       
       while (rbfl.hasNext()) {
            RaceBatchForm form = rbfl.getNextRaceBatchForm();
       }
       
                   
       
  

or

       
       
       while (rbfl.hasNext()) {
            RaceBatchForm[] forms = rbfl.getNextRaceBatchForms(rbfl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextRaceBatchForm

RaceBatchForm getNextRaceBatchForm()
                                   throws OperationFailedException

Gets the next RaceBatchForm in this list.

Returns:

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

getNextRaceBatchForms

RaceBatchForm[] getNextRaceBatchForms(long n)
                                      throws OperationFailedException

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

Parameters:

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

Returns:

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