OSID Logo
OSID Specifications
checklist batch package
Version 3.1.0
Interfaceosid.checklist.batch.TodoBatchFormList
Implementsosid.OsidList
Used Byosid.checklist.batch.TodoBatchAdminSession
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.TodoBatchForm the next TodoBatchForm in this list. The hasNext() method should be used to test that a next TodoBatchForm 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.
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().

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