Interface ILocale


  • @Scriptable
    public interface ILocale
    This interface represents locale settings in up environments.
    • Method Detail

      • getDefaultLanguage

        String getDefaultLanguage()
        Returns the default portal language. The language code might differ from this locale instance's language tag.
        Returns:
        The default language.
      • getLanguages

        String[] getLanguages()
        Returns the list of all supported portal languages. The language codes might differ from this locale instance's language tag.
        Returns:
        The list of all supported portal languages.
      • getLanguageTag

        String getLanguageTag()
        The RFC 3066 language tag.
        Returns:
        The RFC 3066 language tag.
      • isDefault

        boolean isDefault()
        true, if the instance represents the portal's default locale.
        Returns:
        true, if the instance represents the portal's default locale.
      • getDateFormat

        String getDateFormat()
        returns the date format string
        Returns:
        date format
      • getShortDateFormat

        String getShortDateFormat()
      • getLongDateFormat

        String getLongDateFormat()
      • getTimeFormat

        String getTimeFormat()
        returns the time format string
        Returns:
        time format
      • getTimeFormatWithSeconds

        String getTimeFormatWithSeconds()
        returns the time format string
        Returns:
        time format with seconds part
      • getHourFormat

        String getHourFormat()
        Method getHourFormat.
        Returns:
        String
      • getDateTimeFormat

        String getDateTimeFormat()
        returns the datetime format string
        Returns:
        datetime format
      • getDayShortDateFormat

        String getDayShortDateFormat()
        Method getDayShortDateFormat.
        Returns:
        String
      • getIntegerDigitSeparator

        String getIntegerDigitSeparator()
        returns the integer digit separator
        Returns:
        integer digit separator
      • getNumberDecimalSeparator

        String getNumberDecimalSeparator()
        returns the decimal separator
        Returns:
        decimal separator
      • getNumberDigitSeparator

        String getNumberDigitSeparator()
        returns the digit separator
        Returns:
        digit separator
      • isNumberLeadingNulls

        boolean isNumberLeadingNulls()
        returns true, if leading nulls are supported before decimal separator, otherwise false
        Returns:
        leading null flag
      • getNumberFractionDigits

        int getNumberFractionDigits()
        returns the number of fraction digits of float values
        Returns:
        number of fraction digits
      • getCurrencyDecimalSeparator

        String getCurrencyDecimalSeparator()
        returns the decimal separator for currency
        Returns:
        decimal separator
      • getCurrencyDigitSeparator

        String getCurrencyDigitSeparator()
        returns the digit separator for currency
        Returns:
        digit separator
      • isCurrencyLeadingNulls

        boolean isCurrencyLeadingNulls()
        returns true, if leading nulls are supported before decimal separator, otherwise false
        Returns:
        leading null flag
      • getCurrencyFractionDigits

        int getCurrencyFractionDigits()
        returns the number of fraction digits of currency values
        Returns:
        number of fraction digits
      • timeZone

        TimeZone timeZone()
        Returns the timezone or null, if none is set.
        Returns:
        The time zone.
      • getTimeZoneId

        String getTimeZoneId()
        getTimeZone returns the timezone string or null, if none is set. null means the UTC time zone.
        Returns:
        Timezone string
      • getFirstDayOfWeek

        int getFirstDayOfWeek()
        Method getFirstDayOfWeek returns the int value for the first day of a week. e.g. 2 for monday .
        Returns:
        int as Calendar.SUNDAY == 1 to Calendar.SATURDAY == 7 values