OSID - osid.locale.LocaleList Service Interface Definition

Interface	osid.locale.LocaleList
Implements	`osid.OsidList`
Used By	`osid.OsidForm`
Used By	`osid.OsidProfile`
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()); }
Method	getNextLocale
Description	Gets the next `Locale` in this list.
Return	`osid.locale.Locale`		the next `Locale` in this list. The `hasNext()` method should be used to test that a next `Locale` is available before calling this method.
Errors	ILLEGAL_STATE		no more elements available in this list
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getNextLocales
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()`.
Parameters	`cardinal`	`n`	the number of `Locale` elements requested which must be less than or equal to `available()`
Return	`osid.locale.Locale[]`		an array of `Locale` elements. The length of the array is less than or equal to the number specified.
Errors	ILLEGAL_STATE		no more elements available in this list
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.