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

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

                     
                     
                     while (tbfl.hasNext()) {
                          TermBatchForm form = tbfl.getNextTermBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (tbfl.hasNext()) {
                          TermBatchForm[] forms = tbfl.getNextTermBatchForms(tbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextTermBatchForm
Description

Gets the next TermBatchForm in this list.

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

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

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