OSID Logo
OSID Specifications
calendaring package
Version 3.1.0
Interfaceosid.calendaring.SupersedingEventList
Implementsosid.OsidList
Used Byosid.calendaring.RecurringEvent
osid.calendaring.SupersedingEventCalendarSession
osid.calendaring.SupersedingEventLookupSession
osid.calendaring.SupersedingEventQuerySession
osid.calendaring.SupersedingEventSearchResults
osid.calendaring.rules.SupersedingEventEnablerRuleLookupSession
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.SupersedingEvent the next SupersedingEvent in this list. The hasNext() method should be used to test that a next SupersedingEvent is available before calling this method.
ErrorsILLEGAL_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This 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().

Parameterscardinaln the 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_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.