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

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

                     
                     
                     while (el.hasNext()) {
                          Entry entry = el.getNextEntry();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (el.hasNext()) {
                          Entry[] entries = el.getNextEntries(el.available());
                     }
                     
                                 
                     
                
MethodgetNextEntry
Description

Gets the next Entry in this list.

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

Gets the next set of Entry elements in this list which must be less than or equal to the number returned from available().

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