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

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

                     
                     
                     while (mtl.hasNext()) {
                          MeetingTime time = mtl.getNextMeetingTime();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (mtl.hasNext()) {
                          MeetingTime[] times = mtl.getNextMeetingTimes(mtl.available());
                     }
                     
                                 
                     
                
MethodgetNextMeetingTime
Description

Gets the next MeetingTime in this list.

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

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

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