OSID Logo
OSID Specifications
checklist batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.checklist.batch.TodoBatchFormList
Implementsosid.OsidList
Description

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

                     
                     
                     while (tbfl.hasNext()) {
                          TodoBatchForm form = tbfl.getNextTodoBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (tbfl.hasNext()) {
                          TodoBatchForm[] forms = tbfl.getNextTodoBatchForms(tbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextTodoBatchForm
Description

Gets the next TodoBatchForm in this list.

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

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

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