OSID Logo
OSID Specifications
commenting package
Version 3.0.0
Release Candidate Preview
Interfaceosid.commenting.BookNodeList
Implementsosid.OsidList
Description

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

                     
                     
                     while (bnl.hasNext()) {
                          BookNode node = bnl.getNextBookNode();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (bnl.hasNext()) {
                          BookNode[] nodes = bnl.getNextBookNodes(bnl.available());
                     }
                     
                                 
                     
                
MethodgetNextBookNode
Description

Gets the next BookNode in this list.

Returnosid.commenting.BookNodethe next BookNode in this list. The hasNext() method should be used to test that a next BookNode is available before calling this method.
ErrorsILLEGAL_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetNextBookNodes
Description

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

Parameterscardinalnthe number of BookNode elements requested which must be less than or equal to available()
Returnosid.commenting.BookNode[]an array of BookNode elements. The length of the array is less than or equal to the number specified.
ErrorsILLEGAL_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.