OSID Logo
OSID Specifications
recognition batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.recognition.batch.AcademyBatchFormList
Implementsosid.OsidList
Description

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

                     
                     
                     while (abfl.hasNext()) {
                          AcademyBatchForm form = abfl.getNextAcademyBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (abfl.hasNext()) {
                          AcademyBatchForm[] forms = abfl.getNextAcademyBatchForms(abfl.available());
                     }
                     
                                 
                     
                
MethodgetNextAcademyBatchForm
Description

Gets the next AcademyBatchForm in this list.

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

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

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