OSID Logo
OSID Specifications
calendaring cycle batch package
Version 3.1.0
Interfaceosid.calendaring.cycle.batch.CyclicEventBatchFormList
Implementsosid.OsidList
Used Byosid.calendaring.cycle.batch.CyclicEventBatchAdminSession
Description

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

while (cbfl.hasNext()) {
     CyclicEventBatchForm form = cbfl.getNextCyclicEventBatchForm();
}
                
or
while (cbfl.hasNext()) {
     CyclicEventBatchForm[] forms = cbfl.getNextCyclicEventBatchForms(cbfl.available());
}
                
MethodgetNextCyclicEventBatchForm
Description

Gets the next CyclicEventBatchForm in this list.

Returnosid.calendaring.cycle.batch.CyclicEventBatchForm the next CyclicEventBatchForm in this list. The hasNext() method should be used to test that a next CyclicEventBatchForm 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.
MethodgetNextCyclicEventBatchForms
Description

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

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