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

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

                     
                     
                     while (cnl.hasNext()) {
                          ChecklistNode node = cnl.getNextChecklistNode();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (cnl.hasNext()) {
                          ChecklistNode[] nodes = cnl.getNextChecklistNodes(cnl.available());
                     }
                     
                                 
                     
                
MethodgetNextChecklistNode
Description

Gets the next ChecklistNode in this list.

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

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

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