OSID Logo
OSID Specifications
configuration package
Version 3.0.0
Release Candidate Preview
Interfaceosid.configuration.ConfigurationNodeList
Implementsosid.OsidList
Description

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

                     
                     
                     while (cnl.hasNext()) {
                          ConfigurationNode node = cnl.getNextConfigurationNode();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (cnl.hasNext()) {
                          ConfigurationNode[] nodes = cl.getNextConfigurationNodes(cnl.available());
                     }
                     
                                 
                     
                
MethodgetNextConfigurationNode
Description

Gets the next ConfigurationNode in this list.

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

Gets the next set of ConfigurationNode objects in this lis which must be less than or equal to whst is returned from available().

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