org.osid.voting

Interface BallotList

All Superinterfaces:

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

public interface BallotList
extends OsidList

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

       
       
       while (bl.hasNext()) {
            Ballot ballot = bl.getNextBallot();
       }
       
                   
       
  

or

       
       
       while (bl.hasNext()) {
            Ballot[] ballots = bl.getNextBallots(bl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextBallot

Ballot getNextBallot()
                     throws OperationFailedException

Gets the next Ballot in this list.

Returns:

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

getNextBallots

Ballot[] getNextBallots(long n)
                        throws OperationFailedException

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

Parameters:

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

Returns:

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