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

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

                     
                     
                     while (cnl.hasNext()) {
                          CalendarNode node = cnl.getNextCalendarNode();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (cnl.hasNext()) {
                          CalendarNode[] nodes = cnl.getNextCalendarNodes(cnl.available());
                     }
                     
                                 
                     
                
MethodgetNextCalendarNode
Description

Gets the next CalendarNode in this list.

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

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

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