org.osid.forum

Interface ForumNodeList

All Superinterfaces:

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

public interface ForumNodeList
extends OsidList

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

       
       
       while (fnl.hasNext()) {
            ForumNode node = fnl.getNextForumNode();
       }
       
                   
       
  

or

       
       
       while (fnl.hasNext()) {
            ForumNode[] nodes = fnl.getNextForumNodes(fnl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextForumNode

ForumNode getNextForumNode()
                           throws OperationFailedException

Gets the next ForumNode in this list.

Returns:

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

getNextForumNodes

ForumNode[] getNextForumNodes(long n)
                              throws OperationFailedException

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

Parameters:

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

Returns:

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