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

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

                     
                     
                     while (oel.hasNext()) {
                          OffsetEvent event = oel.getNextOffsetEvent();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (oel.hasNext()) {
                          OffsetEvent[] events = oel.getNextOffsetEvents(oel.available());
                     }
                     
                                 
                     
                
MethodgetNextOffsetEvent
Description

Gets the next OffsetEvent in this list.

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

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

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