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

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