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

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

                     
                     
                     while (dbfl.hasNext()) {
                          DocetBatchForm form = dbfl.getNextDocetBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (dbfl.hasNext()) {
                          DocetBatchForm[] forms = dbfl.getNextDocetBatchForms(dbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextDocetBatchForm
Description

Gets the next DocetBatchForm in this list.

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

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

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