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

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

                     
                     
                     while (ebfl.hasNext()) {
                          EnrollmentBatchForm form = ebfl.getNextEnrollmentBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (ebfl.hasNext()) {
                          EnrollmentBatchForm[] forms = ebfl.getNextEnrollmentBatchForms(ebfl.available());
                     }
                     
                                 
                     
                
MethodgetNextEnrollmentBatchForm
Description

Gets the next EnrollmentBatchForm in this list.

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

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

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