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

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

                     
                     
                     while (dl.hasNext()) {
                          Dictionary dictionary = dl.getNextDictionary();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (dl.hasNext()) {
                          Dictionary[] dictionaries = dl.getNextDictionaries(dl.available());
                     }
                     
                                 
                     
                
MethodgetNextDictionary
Description

Gets the next Dictionary in this list.

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

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

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