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

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

                     
                     
                     while (cbfl.hasNext()) {
                          CalendarBatchForm form = cbfl.getNextCalendarBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (cbfl.hasNext()) {
                          CalendarBatchForm[] forms = cbfl.getNextCalendarBatchForms(cbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextCalendarBatchForm
Description

Gets the next CalendarBatchForm in this list.

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

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

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