Package com.iizix.text

Interface IEnumLocaleString

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

  • Method Details

    • getID

      String getID()
      Gets the text ID.
      Returns:
      The text ID string.

    • getFallback

      String getFallback()
      Gets the fallback String.
      Returns:
      The fallback string.

    • asString

      default String asString()
      Gets the plain string 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 getFallback() string is returned.
      Returns:
      The String for the enum in most accurate locale.

    • asString

      default String asString(SessionInfo sessionInfo)
      Gets the plain string 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 getFallback() 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 String for the enum in most accurate locale.

    • asString

      default String asString(ILocaleString localeString)
      Gets the plain string 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 #fallback string is returned.
      Parameters:
      localeString - The localeString instance to used for localization, or null for fallback return value if text ID is not found.
      Returns:
      The String for the enum in most accurate locale.