Package org.osid.locale

The Open Service Interface Definitions for the org.osid.locale service.

See: Description

Interface Summary

Interface	Description
CalendarConversionSession	This session defines methods to convert dates across calendar systems.
CalendarFormattingSession	This session defines methods to format and parse date times of the calendar and time type defined.
CalendarInfo	This interface defines methods to examine a calendar.
CalendarInfoSession	This session defines methods to examine a calendar.
CalendarUnit	A description of a calendar unit.
CoordinateConversionSession	This session defines methods to convert coordinates across coordinate systems.
CoordinateFormattingSession	This session defines methods to format and parse coordinates.
CurrencyConversionSession	This session defines methods to convert currency.
CurrencyFormattingSession	This session defines methods to format and parse currency amounts.
DisplayText	Text to be displayed.
FormatConversionSession	This session defines methods to convert text formats.
Locale	A locale is a collection of types.
LocaleList	Like all OsidLists, LocaleList provides a means for accessing Locale elements sequentially either one at a time or many at a time.
LocaleManager	The locale manager provides access to locale sessions and provides interoperability tests for various aspects of this service.
LocaleProfile	The locale profile describes the interoperability of locale services.
LocaleProxyManager	The locale manager provides access to locale sessions and provides interoperability tests for various aspects of this service.
NumericFormattingSession	This session defines methods to format and parse numbers.
SpatialUnitConversionSession	This session defines methods to convert spatial units.
TimeInfo	This interface defines methods to examine a time.
TranslationAdminSession	This session defines methods to translate and format text between a source and target locale.
TranslationSession	This session defines methods to translate text between a source and target locale.
UnitConversionSession	This session defines methods to convert units across measurement systems.

Package org.osid.locale Description

The Open Service Interface Definitions for the org.osid.locale service.

The Locale OSID provides the service of localizing applications defining interfaces for string translation, measurement unit conversion, calendar conversion, spatial conversion, and currency conversion.

String Translation

The Locale OSID can access and manage string translations using the TranslationSession and TranslationAdminSession respectively. Translations map a pair of strings with language and script Types. The translation services provide a simple means for an OSID Consumer to localize known display strings for an application.

Numeric Formatting

The NumericFormattingSession provides the service of converting numbers to display strings and parsing display strings into numbers. The format of the display string is identified by a numeric format Type. It supports the various numeric types defined among OSID Primitives such as integers, decimals, and cardinal numbers.

Calendar Formatting

The CalendarFormattingSession converts DateTime and Time OSID Primitives to display strings and parses display strings back into DateTimes and Times. The display string formats are specified by a date format Type and time format Type respectively. The calendaring and time systems implemented by DateTime and Time are specified by a calendar Type and time Type. Conversions among calendaring systems are performed using the CalendarConversionSession.

Currency Formatting

The CurrencyFormattingSession converts currency amounts to display strings and parses display strings into currency amounts. The format of the display string is identified by both a currency and a numeric format Type. Conversions among currencies are performed using the CurrencyConversionSession.

Coordinate Formatting

The CoordinateFormattingSession converts Coordinate OSID Primitives to display strings and parses display strings back into Coordinates. The display string formats are specified by a coordinate format Type. The coordinate data is identified by the coordinate record Type. Conversions among calendaring systems are performed using the CoordinateConversionSession.

Unit Conversion

The UnitConversionSession converts units of measurement among unit types. The unit types may represent different units within the same system of measurement or units among different measurement systems where a conversion exists.

Currency Conversion

The CurrencyConversionSession converts a currency amount from one currency system to another where a means for transforming the currency values exists.

Spatial Unit Conversion

The SpatialUnitConversionSession converts a spatial units from one spatial system to another where a means for transforming the spatial units exists.

Text Format Conversion

The FormatConversionSession converts text from one format to another.

Informational Objects

The Locale OSID includes a CalendarInfo and TimeInfo interfaces for inspecting the details of the respective Types to assist in displaying calendars and clocks without knowledge of the specific system.

The Locale interface defines a set of types that together define the formatting, language, calendaring, and currency for a locale or culture. Locale is referenced in OsidSessions to convey the localization of the service.

Copyright © 2010 Ingenescus. All Rights Reserved.

This Work is being provided by the copyright holder(s) subject to the following license. By obtaining, using and/or copying this Work, you agree that you have read, understand, and will comply with the following terms and conditions.

Permission to use, copy and distribute unmodified versions of this Work, for any purpose, without fee or royalty is hereby granted, provided that you include the above copyright notices and the terms of this license on ALL copies of the Work or portions thereof.

You may modify or create Derivatives of this Work only for your internal purposes. You shall not distribute or transfer any such Derivative of this Work to any location or to any third party. For the purposes of this license, "Derivative" shall mean any derivative of the Work as defined in the United States Copyright Act of 1976, such as a translation or modification.

This Work and the information contained herein is provided on an "AS IS" basis WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE WORK OR THE USE OR OTHER DEALINGS IN THE WORK.

The export of software employing encryption technology may require a specific license from the United States Government. It is the responsibility of any person or organization contemplating export to obtain such a license before exporting this Work.