OSID Logo
OSID Specifications
commenting package
Version 3.1.0
Interfaceosid.commenting.BookList
Implementsosid.OsidList
Used Byosid.commenting.BookHierarchySession
osid.commenting.BookLookupSession
osid.commenting.BookQuerySession
osid.commenting.BookSearchResults
osid.commenting.CommentBookSession
Description

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());
}
                
MethodgetNextBook
Description

Gets the next Book in this list.

Returnosid.commenting.Book the next Book in this list. The hasNext() method should be used to test that a next Book is available before calling this method.
ErrorsILLEGAL_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodgetNextBooks
Description

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

Parameterscardinaln the number of Book elements requested which must be less than or equal to available()
Returnosid.commenting.Book[] an array of Book elements. The length of the array is less than or equal to the number specified.
ErrorsILLEGAL_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.