OSID Logo
OSID Specifications
course program batch package
Version 3.1.0
Interfaceosid.course.program.batch.ProgramBatchFormList
Implementsosid.OsidList
Used Byosid.course.program.batch.ProgramBatchAdminSession
Description

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

while (pbfl.hasNext()) {
     ProgramBatchForm form = pbfl.getNextProgramBatchForm();
}
                
or
while (pbfl.hasNext()) {
     ProgramBatchForm[] forms = pbfl.getNextProgramBatchForms(pbfl.available());
}
                
MethodgetNextProgramBatchForm
Description

Gets the next ProgramBatchForm in this list.

Returnosid.course.program.batch.ProgramBatchForm the next ProgramBatchForm in this list. The hasNext() method should be used to test that a next ProgramBatchForm 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.
MethodgetNextProgramBatchForms
Description

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

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