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

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

                     
                     
                     while (tpbfl.hasNext()) {
                          TimePeriodBatchForm form = tpbfl.getNextTimePeriodBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (tpbfl.hasNext()) {
                          TimePeriodBatchForm[] forms = tpbfl.getNextTimePeriodBatchForms(tpbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextTimePeriodBatchForm
Description

Gets the next TimePeriodBatchForm in this list.

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

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

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