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

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

                     
                     
                     while (gbfl.hasNext()) {
                          GradeBatchForm form = gbfl.getNextGradeBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (gbfl.hasNext()) {
                          GradeBatchForm[] forms = gsbfl.getNextGradeBatchForms(gbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextGradeBatchForm
Description

Gets the next GradeBatchForm in this list.

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

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

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