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

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

                     
                     
                     while (cobfl.hasNext()) {
                          OffsetEventBatchForm form = cobfl.getNextOffsetEventBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (cobfl.hasNext()) {
                          OffsetEventBatchForm[] forms = cobfl.getNextOffsetEventBatchForms(cobfl.available());
                     }
                     
                                 
                     
                
MethodgetNextOffsetEventBatchForm
Description

Gets the next OffsetEventBatchForm in this list.

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

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

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