Package com.iizix.text

Interface IEnumLocaleKString

All Superinterfaces:
IEnumLocaleString
All Known Implementing Classes:
LocaleString, References.ReturnCode
public interface IEnumLocaleKString extends IEnumLocaleString
Interface used by enum's to retrieve the "id" and the "fallback" strings when formatting values to locale String's and KString's.
Author:
Christopher Mindus

  • Method Details

    • getKStringFallback

      KString getKStringFallback()
      Gets the fallback KString.
      Returns:
      The fallback KString.

    • asKString

      default KString asKString()
      Gets the KString for an enum value. The string will be in the client session's language setting, the application session's setting or the default language setting and if none of these were found in the specified order, the getKStringFallback() string is returned.
      Returns:
      The KString for the enum in most accurate locale.

    • asKString

      default KString asKString(SessionInfo sessionInfo)
      Gets the KString for an enum value. The string will be in the client session's language setting, the application session's setting or the default language setting and if none of these were found in the specified order, the getKStringFallback() string is returned.
      Parameters:
      sessionInfo - The session information, or null if not available. if null the system will attempt to look up the current client or application session from the current thread.
      Returns:
      The KString for the enum in most accurate locale.