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

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

                     
                     
                     while (dtl.hasNext()) {
                          DateTime time = dtl.getNextDateTime();
                     }
                     
                                 
                     
                
or
                     
                     
                     while dtl.hasNext()) {
                          DateTime[] times = dtl.getNextDateTimes(dtl.available());
                     }
                     
                                 
                     
                
MethodgetNextDateTime
Description

Gets the next DateTime in this list.

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

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

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