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

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

                     
                     
                     while (cbfl.hasNext()) {
                          CourseBatchForm form = cbfl.getNextCourseBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (cbfl.hasNext()) {
                          CourseBatchForm[] forms = cbfl.getNextCourseBatchForms(cbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextCourseBatchForm
Description

Gets the next CourseBatchForm in this list.

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

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

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