OSID Logo
OSID Specifications
recognition batch package
Version 3.1.0
Interfaceosid.recognition.batch.AcademyBatchFormList
Implementsosid.OsidList
Used Byosid.recognition.batch.AcademyBatchAdminSession
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.AcademyBatchForm the next AcademyBatchForm in this list. The hasNext() method should be used to test that a next AcademyBatchForm is available before calling this method.
ErrorsILLEGAL_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This 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().

Parameterscardinaln the 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_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.