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

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

                     
                     
                     while (cobfl.hasNext()) {
                          CourseOfferingBatchForm form = cobfl.getNextCourseOfferingBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (cobfl.hasNext()) {
                          CourseOfferingBatchForm[] forms = cobfl.getNextCourseOfferingBatchForms(cobfl.available());
                     }
                     
                                 
                     
                
MethodgetNextCourseOfferingBatchForm
Description

Gets the next CourseOfferingBatchForm in this list.

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

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

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