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

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

                     
                     
                     while (tp.hasNext()) {
                          TimePeriod period = tp.getNextTimePeriod();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (tp.hasNext()) {
                          TimePeriod[] periods = tp.getNextTimePeriods(tp.available());
                     }
                     
                                 
                     
                
MethodgetNextTimePeriod
Description

Gets the next TimePeriod in this list.

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

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

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