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

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

                     
                     
                     while (abfl.hasNext()) {
                          AwardBatchForm form = abfl.getNextAwardBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (abfl.hasNext()) {
                          AwardBatchForm[] forms = abfl.getNextAwardBatchForms(abfl.available());
                     }
                     
                                 
                     
                
MethodgetNextAwardBatchForm
Description

Gets the next AwardBatchForm in this list.

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

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

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