OSID Logo
OSID Specifications
calendaring batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.calendaring.batch.ScheduleBatchFormList
Implementsosid.OsidList
Description

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

                     
                     
                     while (sbfl.hasNext()) {
                          ScheduleBatchForm form = sbfl.getNextScheduleBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (sbfl.hasNext()) {
                          ScheduleBatchForm[] forms = sbfl.getNextScheduleBatchForms(sbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextScheduleBatchForm
Description

Gets the next ScheduleBatchForm in this list.

Returnosid.calendaring.batch.ScheduleBatchFormthe next ScheduleBatchForm in this list. The hasNext() method should be used to test that a next ScheduleBatchForm is available before calling this method.
ErrorsILLEGAL_STATEno more elements available in this list
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetNextScheduleBatchForms
Description

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

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