OSID Logo
OSID Specifications
learning batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.learning.batch.ProficiencyBatchFormList
Implementsosid.OsidList
Description

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

                     
                     
                     while (pbfl.hasNext()) {
                          ProficiencyBatchForm form = pbfl.getNextProficiencyBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (pbfl.hasNext()) {
                          ProficiencyBatchForm[] forms = pbfl.getNextProficiencyBatchForms(pbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextProficiencyBatchForm
Description

Gets the next ProficiencyBatchForm in this list.

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

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

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