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

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

                     
                     
                     while (cbfl.hasNext()) {
                          ConvocationBatchForm form = cbfl.getNextConvocationBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (cbfl.hasNext()) {
                          ConvocationBatchForm[] forms = cbfl.getNextConvocationBatchForms(cbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextConvocationBatchForm
Description

Gets the next ConvocationBatchForm in this list.

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

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

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