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

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

                     
                     
                     while (rel.hasNext()) {
                          RecurringEvent event = rel.getNextRecurringEvent();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (rel.hasNext()) {
                          RecurringEvent[] events = rel.getNextRecurringEvents(rel.available());
                     }
                     
                                 
                     
                
MethodgetNextRecurringEvent
Description

Gets the next RecurringEvent in this list.

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

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

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