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

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

                     
                     
                     while (el.hasNext()) {
                          Event event = el.getNextEvent();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (el.hasNext()) {
                          Event[] events = el.getNextEvents(el.available());
                     }
                     
                                 
                     
                
MethodgetNextEvent
Description

Gets the next Event in this list.

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

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

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