org.osid.voting.batch

Interface VotePeerList

All Superinterfaces:

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

public interface VotePeerList
extends OsidList

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

       
       
       while (vpl.hasNext()) {
            VotePeer peer = vpl.getNextVotePeer();
       }
       
                   
       
  

or

       
       
       while (vpl.hasNext()) {
            VotePeer[] peers = vpl.getNextVotePeers(vpl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextVotePeer

VotePeer getNextVotePeer()
                         throws OperationFailedException

Gets the next VotePeer in this list.

Returns:

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

getNextVotePeers

VotePeer[] getNextVotePeers(long n)
                            throws OperationFailedException

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

Parameters:

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

Returns:

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