Configuring Siebel Open UI > Siebel Open UI Application Programming Interface > Methods of the Siebel Open UI Application Programming Interface >

Locale Object Class

This topic describes the methods that Siebel Open UI uses with the Locale Object class. It includes the following information:

• FormattedToString Method
• GetCurrencyList Method
• GetDateFormat Method
• GetDayOfWeek Method
• GetDispCurrencyDecimal Method
• GetDispCurrencySeparator Method
• GetDispDateSeparator Method
• GetDispNumberDecimal Method
• GetDispNumberScale Method
• GetDispNumberSeparator Method
• GetDispTimeAM Method
• GetDispTimePM Method
• GetDispTimeSeparator Method
• GetExchangeRate Method
• GetFuncCurrCode Method
• GetLocalString Method
• GetMonth Method
• GetScale Method
• GetStringFromDateTime Method
• GetTimeFormat Method
• GetTimeZoneList Method
• GetTimeZoneName Method
• SetCurrencyCode Method
• SetExchDate Method
• SetScale Method
• StringToFormatted Method

FormattedToString Method

The FormattedToString method removes the formatting of a string. It returns the unformatted string. It uses the following syntax:

FormattedToString(type,value,format)

where:

• type is a string that identifies the value type of the string. For example: Phone, Currency, DateTime, or Integer.
• value is a string that identifies the formatted value of the string.
• format is a string that identifies the optional format of the string.

For example:

SiebelApp.S_App.LocaleObject.FormattedToString("date","11/05/2012","M/D/YYYY")

GetCurrencyList Method

The GetCurrencyList method returns the currency list that the client computer supports. It uses the following syntax:

GetCurrencyList()

It includes no arguments.

For example:

SiebelApp.S_App.LocaleObject.GetCurrencyList()

GetDateFormat Method

The GetDateFormat method returns the date format for the locale. It uses the following syntax:

GetDateFormat()

It includes no arguments.

For example:

SiebelApp.S_App.LocaleObject.GetDateFormat()

GetDayOfWeek Method

The GetDayOfWeek method returns a string that identifies the day of the week. It uses the following syntax:

GetDayOfWeek(day,format)

where:

• day is a number that indicates the index of the day.
• format is string that specifies the day format.

For example:

SiebelApp.S_App.LocaleObject.GetDayOfWeek(20,"M/D/YYYY")

GetDispCurrencyDecimal Method

The GetDispCurrencyDecimal method returns the decimal point symbol that the client uses for currency, such as a period (.). It uses the following syntax:

GetDispCurrencyDecimal()

It includes no arguments.

For example:

SiebelApp.S_App.LocaleObject.GetDispCurrencyDecimal()

GetDispCurrencySeparator Method

The GetDispCurrencySeparator method the number separator that the currency uses to separate digits in a currency, such as a comma (,). It uses the following syntax:

GetDispCurrencySeparator()

It includes no arguments.

For example:

SiebelApp.S_App.LocaleObject.GetDispCurrencySeparator()

GetDispDateSeparator Method

The GetDispDateSeparator method returns the symbol that the client uses to separate the days, weeks, and months of a date. It uses the following syntax:

GetDispDateSeparator()

It includes no arguments.

For example:

SiebelApp.S_App.LocaleObject.GetDispDateSeparator()

GetDispNumberDecimal Method

The GetDispNumberDecimal method returns the symbol that the client uses for the decimal point. For example, a period (.). It uses the following syntax:

GetDispNumberDecimal()

It includes no arguments.

For example:

SiebelApp.S_App.LocaleObject.GetDispNumberDecimal())

GetDispNumberScale Method

The GetDispNumberScale method returns the number of fractional digits that the client displays. For example, 2. It uses the following syntax:

GetDispNumberScale()

It includes no arguments.

For example:

SiebelApp.S_App.LocaleObject.GetDispNumberScale()

GetDispNumberSeparator Method

The GetDispNumberSeparator method returns the symbol that the client uses to separate digits in a number. For example, the comma (,). It uses the following syntax:

GetDispNumberSeparator()

It includes no arguments.

For example:

SiebelApp.S_App.LocaleObject.GetDispNumberSeparator())

GetDispTimeAM Method

The GetDispTimeAM method returns the localized string for AM. For example, AM. It uses the following syntax:

GetDispTimeAM()

It includes no arguments.

For example:

SiebelApp.S_App.LocaleObject.GetDispTimeAM()

GetDispTimePM Method

The GetDispTimePM method returns the localized string for PM. For example, PM. It uses the following syntax:

GetDispTimePM()

It includes no arguments.

For example:

SiebelApp.S_App.LocaleObject.GetDispTimePM()

GetDispTimeSeparator Method

The GetDispTimeSeparator method returns the symbol that the client uses to separate the parts of time. For example, the colon (:) symbol. It uses the following syntax:

GetDispTimeSeparator()

It includes no arguments.

For example:

SiebelApp.S_App.LocaleObject.GetDispTimeSeparator()

GetExchangeRate Method

The GetExchangeRate method calculates the exchange rate between two currencies. It returns the exchange rate as a double precision, floating point number. It uses the following syntax:

GetExchangeRate(input_value, output_value, exchange_date)

where:

• input_value is a string that identifies the currency code that Siebel Open UI uses for the input value when it calculates the exchange rate.
• output_value is a string that identifies the currency code that Siebel Open UI uses for the output value when it calculates the exchange rate.
• exchange_date is a string that includes the date of the currency exchange.

For example:

SiebelApp.S_App.LocaleObject.GetExchangeRate("USD", "INR", "11/05/2012")

GetFuncCurrCode Method

The GetFuncCurrCode method returns the currency code that the client uses. For example, USD. It uses the following syntax:

GetFuncCurrCode()

It includes no arguments.

For example:

SiebelApp.S_App.LocaleObject.GetFuncCurrCode()

GetLocalString Method

The GetLocalString method returns the localized string of a key. It uses the following syntax:

GetLocalString(pStringKey : string_name : message_key)

where:

• pStringKey is a property set that includes the string key.
• string_name is a string that identifies the name of the localized string that GetLocalString gets.

For example, the following code uses the GetLocalString method when using Siebel Open UI with a connected client:

SiebelApp.S_App.LocaleObject.GetLocalString("IDS_SWE_LOADING_INDICATOR_TITLE")

For another example, the following code uses the GetLocalString method when using Siebel Open UI with Siebel Mobile disconnected:

SiebelApp.S_App.OfflineLocaleObject.GetLocalString("IDS_SWE_LOADING_INDICATOR_TITLE")

GetMonth Method

The GetMonth method returns the month that the locale uses. It uses the following syntax:

GetMonth()

It includes no arguments.

For example:

SiebelApp.S_App.LocaleObject.GetMonth()

GetScale Method

The GetScale method returns the scale of the number that Siebel Open UI must display. It uses the following syntax:

GetScale()

It includes no arguments.

For example:

SiebelApp.S_App.LocaleObject.GetScale()

GetStringFromDateTime Method

The GetStringFromDateTime method formats a date and time string. It returns this formatted date and time in a string. It uses the following syntax:

GetStringFromDateTime(input_date, input_format, output_format)

where:

• input_date specifies the date that GetStringFromDateTime formats.
• input_format describes how input_date is formatted.
• output_format specifies how to format the output.

For example:

SiebelApp.S_App.LocaleObject.GetStringFromDateTime(2012-12-05, DD/MM/YYYY, M/D/YYYY)

GetTimeFormat Method

The GetTimeFormat method returns the time format that the locale uses. It uses the following syntax:

GetTimeFormat()

It includes no arguments.

For example:

SiebelApp.S_App.LocaleObject.GetTimeFormat()

GetTimeZoneList Method

The GetTimeZoneList method returns a list of time zones that the locale uses. It uses the following syntax:

GetTimeZoneList()

It includes no arguments.

For example:

SiebelApp.S_App.LocaleObject.GetTimeZoneList()

GetTimeZoneName Method

The GetTimeZoneName method returns the current time zone that the locale uses. It uses the following syntax:

GetTimeZoneName()

It includes no arguments.

For example:

SiebelApp.S_App.LocaleObject.GetTimeZoneName()

SetCurrencyCode Method

The SetCurrencyCode method sets the currency code that the locale uses. It returns nothing. It uses the following syntax:

SetCurrencyCode(currency_code)

where:

• currency_code is a string that includes the currency code.

For example:

SiebelApp.S_App.LocaleObject.SetCurrencyCode("USD")

SetExchDate Method

The SetExchDate method sets the exchange date that the currency uses. It returns nothing. It uses the following syntax:

SetExchDate(exchange_date)

where:

• exchange_date is a string that includes the exchange date.

For example:

SiebelApp.S_App.LocaleObject.SetExchDate("11/05/2012")

SetScale Method

The SetScale method sets the scale of the number. It returns nothing. It uses the following syntax:

SetScale(scale)

where:

• scale is a string that includes the number that SetScale uses to set the scale.

For example:

SiebelApp.S_App.LocaleObject.SetScale("0")

StringToFormatted Method

The StringToFormatted method adds formatting characters to a string. It returns a formatted string. It uses the following syntax:

StringToFormatted(type,value,format)

The StringToFormatted method uses the same arguments that the FormattedToString method uses. For more information, see FormattedToString Method.

For example:

SiebelApp.S_App.LocaleObject.StringToFormatted("date","11/05/2012","M/D/YYYY")