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

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

                     
                     
                     while (pbfl.hasNext()) {
                          ProgramEntryBatchForm form = pbfl.getNextProgramEntryBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (pbfl.hasNext()) {
                          ProgramEntryBatchForm[] forms = pbfl.getNextProgramEntryBatchForms(pbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextProgramEntryBatchForm
Description

Gets the next ProgramEntryBatchForm in this list.

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

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

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