org.osid.blogging

Interface BlogNodeList

All Superinterfaces:

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

public interface BlogNodeList
extends OsidList

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

       
       
       while (bnl.hasNext()) {
            BlogNode node = bnl.getNextBlogNode();
       }
       
                   
       
  

or

       
       
       while (bnl.hasNext()) {
            BlogNode[] nodes = bnl.getNextBlogNodes(bnl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextBlogNode

BlogNode getNextBlogNode()
                         throws OperationFailedException

Gets the next BlogNode in this list.

Returns:

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

getNextBlogNodes

BlogNode[] getNextBlogNodes(long n)
                            throws OperationFailedException

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

Parameters:

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

Returns:

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