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

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

                     
                     
                     while (ssl.hasNext()) {
                          ScheduleSlot slot = ssl.getNextSchedulSlote();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (ssl.hasNext()) {
                          ScheduleSlot[] slots = ssl.getNextScheduleSlots(ssl.available());
                     }
                     
                                 
                     
                
MethodgetNextScheduleSlot
Description

Gets the next ScheduleSlot in this list.

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

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

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