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

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

                     
                     
                     while (ebfl.hasNext()) {
                          EventBatchForm form = ebfl.getNextEventBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (ebfl.hasNext()) {
                          EventBatchForm[] forms = ebfl.getNextEventBatchForms(ebfl.available());
                     }
                     
                                 
                     
                
MethodgetNextEventBatchForm
Description

Gets the next EventBatchForm in this list.

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

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

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