org.osid.voting

Interface PollsNodeList

All Superinterfaces:

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

public interface PollsNodeList
extends OsidList

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

       
       
       while (pnl.hasNext()) {
            PollsNode node = pnl.getNextPollsNode();
       }
       
                   
       
  

or

       
       
       while (pnl.hasNext()) {
            PollsNode[] nodes = pnl.getNextPollsNodes(pnl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextPollsNode

PollsNode getNextPollsNode()
                           throws OperationFailedException

Gets the next PollsNode in this list.

Returns:

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

getNextPollsNodes

PollsNode[] getNextPollsNodes(long n)
                              throws OperationFailedException

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

Parameters:

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

Returns:

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