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

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

                     
                     
                     while (cl.hasNext()) {
                          Calendar calendar = cl.getNextCalendar();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (cl.hasNext()) {
                          Calendar[] calendars = cl.getNextCalendars(cl.available());
                     }
                     
                                 
                     
                
MethodgetNextCalendar
Description

Gets the next Calendar in this list.

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

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

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