OSID Logo
OSID Specifications
course syllabus batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.syllabus.batch.ModuleBatchFormList
Implementsosid.OsidList
Description

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

                     
                     
                     while (mbfl.hasNext()) {
                          ModuleBatchForm form = mbfl.getNextModuleBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (mbfl.hasNext()) {
                          ModuleBatchForm[] forms = mbfl.getNextModuleBatchForms(mbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextModuleBatchForm
Description

Gets the next ModuleBatchForm in this list.

Returnosid.course.syllabus.batch.ModuleBatchFormthe next ModuleBatchForm in this list. The hasNext() method should be used to test that a next ModuleBatchForm is available before calling this method.
ErrorsILLEGAL_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetNextModuleBatchForms
Description

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

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