org.osid.voting.batch

Interface PollsBatchFormList

All Superinterfaces:

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

public interface PollsBatchFormList
extends OsidList

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

       
       
       while (pbfl.hasNext()) {
            PollsBatchForm form = pbfl.getNextPollsBatchForm();
       }
       
                   
       
  

or

       
       
       while (pbfl.hasNext()) {
            PollsBatchForm[] forms = pbfl.getNextPollsBatchForms(pbfl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextPollsBatchForm

PollsBatchForm getNextPollsBatchForm()
                                     throws OperationFailedException

Gets the next PollsBatchForm in this list.

Returns:

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

getNextPollsBatchForms

PollsBatchForm[] getNextPollsBatchForms(long n)
                                        throws OperationFailedException

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

Parameters:

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

Returns:

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