OSID Logo
OSID Specifications
locale package
Version 3.0.0
Release Candidate Preview
Interfaceosid.locale.LocaleList
Implementsosid.OsidList
Description

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

                     
                     
                     while (ll.hasNext()) {
                          Locale locale = ll.getNextLocale();
                     }
                     
                                 
                     
                
or
                     
                     
                     while (ll.hasNext()) {
                          Locale[] locales = ll.getNextLocales(ll.available());
                     }
                     
                                 
                     
                
MethodgetNextLocale
Description

Gets the next Locale in this list.

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

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

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