org.osid.checklist

Interface TodoNodeList

All Superinterfaces:

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

public interface TodoNodeList
extends OsidList

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

       
       
       while (tnl.hasNext()) {
            TodoNode node = tnl.getNextTodoNode();
       }
       
                   
       
  

or

       
       
       while (tnl.hasNext()) {
            TodoNode[] nodes = tnl.getNextTodoNodes(tnl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextTodoNode

TodoNode getNextTodoNode()
                         throws OperationFailedException

Gets the next TodoNode in this list.

Returns:

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

getNextTodoNodes

TodoNode[] getNextTodoNodes(long n)
                            throws OperationFailedException

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

Parameters:

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

Returns:

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