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

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

                     
                     
                     while (cbfl.hasNext()) {
                          ChecklistBatchForm form = cbfl.getNextChecklistBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (cbfl.hasNext()) {
                          ChecklistBatchForm[] forms = cbfl.getNextChecklistBatchForms(cbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextChecklistBatchForm
Description

Gets the next ChecklistBatchForm in this list.

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

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

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