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

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

                     
                     
                     while (seel.hasNext()) {
                          SupersedingEventEnabler enabler = seel.getNextSupersedingEventEnabler();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (seel.hasNext()) {
                          SupersedingEventEnabler[] enablers = seel.getNextSupersedingEventEnablers(seel.available());
                     }
                     
                                 
                     
                
MethodgetNextSupersedingEventEnabler
Description

Gets the next SupersedingEventEnabler in this list.

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

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

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