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

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

                     
                     
                     while (sl.hasNext()) {
                          Schedule schedule = sl.getNextSchedule();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (sl.hasNext()) {
                          Schedule[] schedules = sl.getNextSchedules(sl.available());
                     }
                     
                                 
                     
                
MethodgetNextSchedule
Description

Gets the next Schedule in this list.

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

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

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