org.osid.forum

Interface ForumList

All Superinterfaces:

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

public interface ForumList
extends OsidList

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

       
       
       while (fl.hasNext()) {
            Forum forum = fl.getNextForum();
       }
       
                   
       
  

or

       
       
       while (fl.hasNext()) {
            Forum[] forums = fl.getNextForums(fl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextForum

Forum getNextForum()
                   throws OperationFailedException

Gets the next Forum in this list.

Returns:

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

getNextForums

Forum[] getNextForums(long n)
                      throws OperationFailedException

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

Parameters:

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

Returns:

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