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

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

                     
                     
                     while (tl.hasNext()) {
                          Time time = tl.getNextTime();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (tl.hasNext()) {
                          Time[] times = tl.getNextTimes(tl.available());
                     }
                     
                                 
                     
                
MethodgetNextTime
Description

Gets the next Time in this list.

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

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

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