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

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

                     
                     
                     while (pobfl.hasNext()) {
                          ProgramOfferingBatchForm form = pobfl.getNextProgramOfferingBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (pobfl.hasNext()) {
                          ProgramOfferingBatchForm[] forms = pobfl.getNextProgramOfferingBatchForms(pobfl.available());
                     }
                     
                                 
                     
                
MethodgetNextProgramOfferingBatchForm
Description

Gets the next ProgramOfferingBatchForm in this list.

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

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

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