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

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

                     
                     
                     while (ccbfl.hasNext()) {
                          CourseCatalogBatchForm form = ccbfl.getNextCourseCatalogBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (ccbfl.hasNext()) {
                          CourseCatalogBatchForm[] forms = ccbfl.getNextCourseCatalogBatchForms(ccbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextCourseCatalogBatchForm
Description

Gets the next CourseCatalogBatchForm in this list.

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

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

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