OSID Logo
OSID Specifications
grading batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.grading.batch.GradebookBatchFormList
Implementsosid.OsidList
Description

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

                     
                     
                     while (gbfl.hasNext()) {
                          GradebookBatchForm form = gbfl.getNextGradebookBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (gbfl.hasNext()) {
                          GradebookBatchForm[] forms = gbfl.getNextGradebookBatchForms(gbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextGradebookBatchForm
Description

Gets the next GradebookBatchForm in this list.

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

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

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