OSID Logo
OSID Specifications
calendaring batch package
Version 3.1.0
Interfaceosid.calendaring.batch.RecurringEventBatchFormList
Implementsosid.OsidList
Used Byosid.calendaring.batch.RecurringEventBatchAdminSession
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.RecurringEventBatchForm the next RecurringEventBatchForm in this list. The hasNext() method should be used to test that a next RecurringEventBatchForm 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.
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().

Parameterscardinaln the 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_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.