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

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

                     
                     
                     while (dtil.hasNext()) {
                          DateTimeInterval interval = dtil.getNextDateTimeInterval();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (dtil.hasNext()) {
                          DateTimeInterval[] intervals = dtil.getNextDateTimeIntervals(dtil.available());
                     }
                     
                                 
                     
                
MethodgetNextDateTimeInterval
Description

Gets the next DateTimeInterval in this list.

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

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

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