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

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

                     
                     
                     while (dl.hasNext()) {
                          Duration duration = dl.getNextDuration();
                     }
                     
                                 
                     
                
or
                     
                     
                     while dl.hasNext()) {
                          Duration[] durations = dl.getNextDurations(dl.available());
                     }
                     
                                 
                     
                
MethodgetNextDuration
Description

Gets the next Duration in this list.

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

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

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