OSID Logo
OSID Specifications
calendaring package
Version 3.1.0
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.Duration the next Duration in this list. The hasNext() method should be used to test that a next Duration is available before calling this method.
ErrorsILLEGAL_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This 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().

Parameterscardinaln the 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_STATE no more elements available in this list
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.