OSID Logo
OSID Specifications
course chronicle batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.chronicle.batch.AwardEntryBatchFormList
Implementsosid.OsidList
Description

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

                     
                     
                     while (abfl.hasNext()) {
                          AwardEntryBatchForm form = abfl.getNextAwardEntryBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (abfl.hasNext()) {
                          AwardEntryBatchForm[] forms = abfl.getNextAwardEntryBatchForms(abfl.available());
                     }
                     
                                 
                     
                
MethodgetNextAwardEntryBatchForm
Description

Gets the next AwardEntryBatchForm in this list.

Returnosid.course.chronicle.batch.AwardEntryBatchFormthe next AwardEntryBatchForm in this list. The hasNext() method should be used to test that a next AwardEntryBatchForm is available before calling this method.
ErrorsILLEGAL_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetNextAwardEntryBatchForms
Description

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

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