org.osid.commenting

Interface CommentList

All Superinterfaces:

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

public interface CommentList
extends OsidList

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

       
       
       while (cl.hasNext()) {
            Comment comment = cl.getNextComment();
       }
       
                   
       
  

or

       
       
       while (cl.hasNext()) {
            Comment[] comments = cl.getNextComments(cl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextComment

Comment getNextComment()
                       throws OperationFailedException

Gets the next Comment in this list.

Returns:

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

getNextComments

Comment[] getNextComments(long n)
                          throws OperationFailedException

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

Parameters:

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

Returns:

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