OSID Logo
OSID Specifications
checklist package
Version 3.0.0
Release Candidate Preview
Interfaceosid.checklist.TodoNodeList
Implementsosid.OsidList
Description

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

                     
                     
                     while (tnl.hasNext()) {
                          TodoNode node = tnl.getNextTodoNode();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (tnl.hasNext()) {
                          TodoNode[] nodes = tnl.getNextTodoNodes(tnl.available());
                     }
                     
                                 
                     
                
MethodgetNextTodoNode
Description

Gets the next TodoNode in this list.

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

Gets the next set of TodoNode elements in this list. The specified amount must be less than or equal to the return from available().

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