org.osid.voting.rules

Interface BallotConstrainerList

All Superinterfaces:

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

public interface BallotConstrainerList
extends OsidList

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

       
       
       while (bcl.hasNext()) {
            BallotConstrainer constrainer = bcl.getNextBallotConstrainer();
       }
       
                   
       
  

or

       
       
       while (bcl.hasNext()) {
            BallotConstrainer[] constrainers = bcl.getNextBallotConstrainers(bcl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextBallotConstrainer

BallotConstrainer getNextBallotConstrainer()
                                           throws OperationFailedException

Gets the next BallotConstrainer in this list.

Returns:

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

getNextBallotConstrainers

BallotConstrainer[] getNextBallotConstrainers(long n)
                                              throws OperationFailedException

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

Parameters:

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

Returns:

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