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

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

                     
                     
                     while (sel.hasNext()) {
                          SupersedingEvent event = sel.getNextSupersedingEvent();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (sel.hasNext()) {
                          SupersedingEvent[] events = sel.getNextSupersedingEvents(sel.available());
                     }
                     
                                 
                     
                
MethodgetNextSupersedingEvent
Description

Gets the next SupersedingEvent in this list.

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

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

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