OSID Logo
OSID Specifications
calendaring package
Version 3.1.0
Interfaceosid.calendaring.TimeList
Implementsosid.OsidList
Description

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

while (tl.hasNext()) {
     Time time = tl.getNextTime();
}
                
or
while (tl.hasNext()) {
     Time[] times = tl.getNextTimes(tl.available());
}
                
MethodgetNextTime
Description

Gets the next Time in this list.

Returnosid.calendaring.Time the next Time in this list. The hasNext() method should be used to test that a next Time 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.
MethodgetNextTimes
Description

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

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