Objects¶

Locale¶

class dlkit.locale.objects.Locale¶

A locale is a collection of types.

Locale defines a set of types that together define the formatting, language, calendaring, and currency for a locale or culture.

language_type¶

Gets the language Type.

Returns:	the language type
Return type:	`osid.type.Type`

compliance: mandatory – This method must be implemented.

script_type¶

Gets the script Type.

Returns:	the script type
Return type:	`osid.type.Type`

compliance: mandatory – This method must be implemented.

calendar_type¶

Gets the calendar Type.

Returns:	the calendar type
Return type:	`osid.type.Type`

compliance: mandatory – This method must be implemented.

time_type¶

Gets the time Type.

Returns:	the time type
Return type:	`osid.type.Type`

compliance: mandatory – This method must be implemented.

currency_type¶

Gets the currency Type.

Returns:	the currency type
Return type:	`osid.type.Type`

compliance: mandatory – This method must be implemented.

unit_system_type¶

Gets the unit system Type.

Returns:	the unit system type
Return type:	`osid.type.Type`

compliance: mandatory – This method must be implemented.

numeric_format_type¶

Gets the numeric format Type.

Returns:	the numeric format type
Return type:	`osid.type.Type`

compliance: mandatory – This method must be implemented.

calendar_format_type¶

Gets the calendar format Type.

Returns:	the calendar format type
Return type:	`osid.type.Type`

compliance: mandatory – This method must be implemented.

time_format_type¶

Gets the time format Type.

Returns:	the time format type
Return type:	`osid.type.Type`

compliance: mandatory – This method must be implemented.

currency_format_type¶

Gets the currency format Type.

Returns:	the currency format type
Return type:	`osid.type.Type`

compliance: mandatory – This method must be implemented.

coordinate_format_type¶

Gets the coordinate format Type.

Returns:	the coordinate format type
Return type:	`osid.type.Type`

compliance: mandatory – This method must be implemented.

Locale List¶

class dlkit.locale.objects.LocaleList¶

Bases: dlkit.osid.objects.OsidList

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());

}

next_locale¶

Gets the next Locale in this list.

Returns:	the next `Locale` in this list. The `has_next()` method should be used to test that a next `Locale` is available before calling this method.
Return type:	`osid.locale.Locale`
Raise:	`IllegalState` – no more elements available in this list
Raise:	`OperationFailed` – unable to complete request

compliance: mandatory – This method must be implemented.

get_next_locales(n)¶

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:	n (`cardinal`) – the number of `Locale` elements requested which must be less than or equal to `available()`
Returns:	an array of `Locale` elements.The length of the array is less than or equal to the number specified.
Return type:	`osid.locale.Locale`
Raise:	`IllegalState` – no more elements available in this list
Raise:	`OperationFailed` – unable to complete request

compliance: mandatory – This method must be implemented.