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

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

                     
                     
                     while (sbfl.hasNext()) {
                          SyllabusBatchForm form = sbfl.getNextSyllabusBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (sbfl.hasNext()) {
                          SyllabusBatchForm[] forms = sbfl.getNextSyllabusBatchForms(sbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextSyllabusBatchForm
Description

Gets the next SyllabusBatchForm in this list.

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

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

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