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

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

                     
                     
                     while (reel.hasNext()) {
                          RecurringEventEnabler enabler = reel.getNextRecurringEventEnabler();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (reel.hasNext()) {
                          RecurringEventEnabler[] enablers = reel.getNextRecurringEventEnablers(reel.available());
                     }
                     
                                 
                     
                
MethodgetNextRecurringEventEnabler
Description

Gets the next RecurringEventEnabler in this list.

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

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

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