org.osid.voting

Interface PollsList

All Superinterfaces:

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

public interface PollsList
extends OsidList

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

       
       
       while (pl.hasNext()) {
            Polls polls = pl.getNextPolls();
       }
       
                   
       
  

or

       
       
       while (pl.hasNext()) {
            Polls[] polls = pl.getNextPollses(pl.available());
       }
       
                   
       
  

Method Summary

Methods

Modifier and Type	Method and Description
Polls	getNextPolls() Gets the next Polls in this list.
Polls[]	getNextPollses(long n) Gets the next set of Polls elements in this list which must be less than or equal to the return from available().

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

getNextPolls

Polls getNextPolls()
                   throws OperationFailedException

Gets the next Polls in this list.

Returns:

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

getNextPollses

Polls[] getNextPollses(long n)
                       throws OperationFailedException

Gets the next set of Polls elements in this list which must be less than or equal to the return from available().

Parameters:

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

Returns:

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