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

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

                     
                     
                     while (bbfl.hasNext()) {
                          BookBatchForm form = bbfl.getNextBookBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (bbfl.hasNext()) {
                          BookBatchForm[] forms = bbfl.getNextBookBatchForms(bbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextBookBatchForm
Description

Gets the next BookBatchForm in this list.

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

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

Parameterscardinalnthe number of BookBatchForm elements requested which must be less than or equal to available()
Returnosid.commenting.batch.BookBatchForm[]an array of BookBatchForm 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.