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

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

                     
                     
                     while (cel.hasNext()) {
                          CyclicEvent event = cel.getNextCyclicEvent();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (cel.hasNext()) {
                          CyclicEvent[] events = cel.getNextCyclicEvents(cel.available());
                     }
                     
                                 
                     
                
MethodgetNextCyclicEvent
Description

Gets the next CyclicEvent in this list.

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

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

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