Interface VoteList

All Superinterfaces:

AutoCloseable, Closeable, OsidList, OsidList

public interface VoteList
extends OsidList

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

while (vl.hasNext()) {
     Vote vote = vl.getNextVote();
}            
  

or

while (vl.hasNext()) {
     Vote[] votes = vl.getNextVotes(vl.available());
}            
  

Method Summary

Modifier and Type	Method	Description
Vote	getNextVote()	Gets the next Vote in this list.
Vote[]	getNextVotes(long n)	Gets the next set of Vote elements in this list which must be less than or equal to the number returned from available() .

Methods inherited from interface Closeable

close

Methods inherited from interface OsidList

close

Modifier and Type	Method	Description
void	close()	Close this list.

Methods inherited from interface OsidList

available, hasNext, skip

Modifier and Type	Method	Description
long	available()	Gets the number of elements available for retrieval.
boolean	hasNext()	Tests if there are more elements in this list.
void	skip(long n)	Skip the specified number of elements in the list.

Method Details

getNextVote

Vote getNextVote()
          throws OperationFailedException

Gets the next Vote in this list.

Returns:

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

getNextVotes

Vote[] getNextVotes(long n)
             throws OperationFailedException

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

Parameters:

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

Returns:

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