org.osid.commenting

Interface BookNodeList

All Superinterfaces:

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

public interface BookNodeList
extends OsidList

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

       
       
       while (bnl.hasNext()) {
            BookNode node = bnl.getNextBookNode();
       }
       
                   
       
  

or

       
       
       while (bnl.hasNext()) {
            BookNode[] nodes = bnl.getNextBookNodes(bnl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextBookNode

BookNode getNextBookNode()
                         throws OperationFailedException

Gets the next BookNode in this list.

Returns:

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

getNextBookNodes

BookNode[] getNextBookNodes(long n)
                            throws OperationFailedException

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

Parameters:

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

Returns:

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