org.osid.commenting

Interface BookList

All Superinterfaces:

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

public interface BookList
extends OsidList

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

       
       
       while (bl.hasNext()) {
            Book book = bl.getNextBook();
       }
       
                   
       
  

or

       
       
       while (bl.hasNext()) {
            Book[] books = bl.getNextBooks(bl.available());
       }
       
                   
       
  

Method Summary

Methods

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

getNextBook

Book getNextBook()
                 throws OperationFailedException

Gets the next Book in this list.

Returns:

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

getNextBooks

Book[] getNextBooks(long n)
                    throws OperationFailedException

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

Parameters:

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

Returns:

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