OSID Logo
OSID Specifications
dictionary package
Version 3.0.0
Release Candidate Preview
Interfaceosid.dictionary.DictionaryNodeList
Implementsosid.OsidList
Description

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

                     
                     
                     while (dnl.hasNext()) {
                          DictionaryNode node = dnl.getNextDictionaryNode();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (dnl.hasNext()) {
                          DictionaryNode[] nodes = dnl.getNextDictionaryNodes(dnl.available());
                     }
                     
                                 
                     
                
MethodgetNextDictionaryNode
Description

Gets the next DictionaryNode in this list.

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

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

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