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

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

                     
                     
                     while (ctpl.hasNext()) {
                          CyclicTimePeriod period = ctpl.getNextCyclicTimePeriod();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (ctpl.hasNext()) {
                          CyclicTimePeriod[] periods = ctpl.getNextCyclicTimePeriods(ctpl.available());
                     }
                     
                                 
                     
                
MethodgetNextCyclicTimePeriod
Description

Gets the next CyclicTimePeriod in this list.

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

Gets the next set of CyclicTimePeriod elements in this list which must be less than or equal to the number returned from available().

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