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

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

                     
                     
                     while (ctpbfl.hasNext()) {
                          CyclicTimePeriodBatchForm form = ctpbfl.getNextCyclicTimePeriodBatchForm();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (ctpbfl.hasNext()) {
                          CyclicTimePeriodBatchForm[] forms = ctpbfl.getNextCyclicTimePeriodBatchForms(ctpbfl.available());
                     }
                     
                                 
                     
                
MethodgetNextCyclicTimePeriodBatchForm
Description

Gets the next CyclicTimePeriodBatchForm in this list.

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

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

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