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

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

                     
                     
                     while (rebfl.hasNext()) {
                          RecurringEventBatchForm form = rebfl.getNextRecurringEventBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (rebfl.hasNext()) {
                          RecurringEventBatchForm[] forms = rebfl.getNextRecurringEventBatchForms(rebfl.available());
                     }
                     
                                 
                     
                
MethodgetNextRecurringEventBatchForm
Description

Gets the next RecurringEventBatchForm in this list.

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

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

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