Interface I_CmsClientMessageBundle

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String export​(java.lang.String localeName)
      Returns the JSON code for this resource bundle and given locale.
      java.lang.String export​(java.util.Locale locale)
      Returns the JSON code for this resource bundle and given locale.
      java.lang.String export​(java.util.Locale locale, boolean wrapScript)
      Returns the JSON code for this resource bundle and given locale.
      java.lang.String export​(javax.servlet.http.HttpServletRequest request)
      Returns the JSON code for this resource bundle and the default locale.
      java.lang.String getBundleName()
      Returns the bundle name for this OpenCms package.
      java.lang.Class<?> getClientImpl()
      Returns the class of the client implementation.
    • Method Detail

      • export

        java.lang.String export​(javax.servlet.http.HttpServletRequest request)
        Returns the JSON code for this resource bundle and the default locale.

        Parameters:
        request - the current request to get the default locale from
        Returns:
        the JSON code
      • export

        java.lang.String export​(java.util.Locale locale)
        Returns the JSON code for this resource bundle and given locale.

        Parameters:
        locale - the locale to export
        Returns:
        the JSON code
      • export

        java.lang.String export​(java.util.Locale locale,
                                boolean wrapScript)
        Returns the JSON code for this resource bundle and given locale.

        Parameters:
        locale - the locale to export
        wrapScript - true to wrap the data in a script tag
        Returns:
        the JSON code
      • export

        java.lang.String export​(java.lang.String localeName)
        Returns the JSON code for this resource bundle and given locale.

        Parameters:
        localeName - the name of the locale to export
        Returns:
        the JSON code
      • getBundleName

        java.lang.String getBundleName()
        Returns the bundle name for this OpenCms package.

        Returns:
        the bundle name for this OpenCms package
      • getClientImpl

        java.lang.Class<?> getClientImpl()
                                  throws java.lang.Exception
        Returns the class of the client implementation.

        Returns:
        the class of the client implementation
        Throws:
        java.lang.Exception - if something goes wrong