Package com.onenetwork.platform.common.usercontext

Interface PlatformUserProfile

public interface PlatformUserProfile
PlatformUserProfile represents the entirety of what is stored in an HttpSession for a given user. This includes a PlatformUserContext, a default Locale, and preferences describing number formats, date formats and other settings.

  • Method Summary

    Modifier and Type Method Description
    java.lang.String getCurrencyFormat()
    Returns a pattern for the user's preferred currency format as accepted by java.text.DecimalFormat
    java.lang.String getDateFormat()
    Returns a pattern for the user's preferred date format as accepted by java.text.SimpleDateFormat
    FormatValues getFormatValues()
    Returns the user's preferred formatted values like AM/PM symbols as accepted by java.text.SimpleDateFormat
    java.lang.String getLanguage()
    Returns the language code which is comprised of a two-letter language code and sometimes followed by a two-letter country code (such as "en-US")
    java.util.Locale getLocale()
    Returns the user's Locale, as specified in their preferences
    java.lang.String getNumberFormat()
    Returns a pattern for the user's preferred number format as accepted by java.text.DecimalFormat
    PlatformUserContext getPlatformUserContext()
    Returns the user's context
    java.lang.String getTimeFormat()
    Returns a pattern for the user's preferred time format as accepted by java.text.SimpleDateFormat
    java.util.TimeZone getTimeZone()
    Returns the user's preferred TimeZone.

  • Method Details

    • getPlatformUserContext

      PlatformUserContext getPlatformUserContext()
      Returns the user's context
      Returns:
      the user's context

    • getLocale

      java.util.Locale getLocale()
      Returns the user's Locale, as specified in their preferences
      Returns:
      the user's Locale, as specified in their preferences

    • getCurrencyFormat

      java.lang.String getCurrencyFormat()
      Returns a pattern for the user's preferred currency format as accepted by java.text.DecimalFormat
      Returns:
      the current currency format pattern

    • getNumberFormat

      java.lang.String getNumberFormat()
      Returns a pattern for the user's preferred number format as accepted by java.text.DecimalFormat
      Returns:
      the current number format pattern

    • getDateFormat

      java.lang.String getDateFormat()
      Returns a pattern for the user's preferred date format as accepted by java.text.SimpleDateFormat
      Returns:
      the current date format pattern

    • getTimeFormat

      java.lang.String getTimeFormat()
      Returns a pattern for the user's preferred time format as accepted by java.text.SimpleDateFormat
      Returns:
      the current time format pattern

    • getLanguage

      java.lang.String getLanguage()
      Returns the language code which is comprised of a two-letter language code and sometimes followed by a two-letter country code (such as "en-US")
      Returns:
      the current language

    • getTimeZone

      java.util.TimeZone getTimeZone()
      Returns the user's preferred TimeZone.
      Returns:
      the current TimeZone object

    • getFormatValues

      FormatValues getFormatValues()
      Returns the user's preferred formatted values like AM/PM symbols as accepted by java.text.SimpleDateFormat
      Returns:
      the user's preferred formatted values