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

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

                     
                     
                     while (cbfl.hasNext()) {
                          ConferralBatchForm form = cbfl.getNextConferralBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (cbfl.hasNext()) {
                          ConferralBatchForm[] forms = cbfl.getNextConferralBatchForms(cbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextConferralBatchForm
Description

Gets the next ConferralBatchForm in this list.

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

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

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