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

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

                     
                     
                     while (cbfl.hasNext()) {
                          CourseEntryBatchForm form = cbfl.getNextCourseEntryBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (cbfl.hasNext()) {
                          CourseEntryBatchForm[] forms = cbfl.getNextCourseEntryBatchForms(cbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextCourseEntryBatchForm
Description

Gets the next CourseEntryBatchForm in this list.

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

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

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