Package lumis.portal.theme

Interface IThemeManagerSPI

  • All Known Implementing Classes:
    ThemeManager
    public interface IThemeManagerSPI
    Theme service provider interface.
    Since:
    7.0.0
    Version:
    $Revision$ $Date$

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.util.Collection<ITheme> getAllThemes()
      Returns all registered themes
      IThemeSPI getTheme​(java.lang.String themeId)
      Returns the theme with the given identifier.
      void register​(java.lang.String themePath)
      Registers a theme in the specified classpath relative path.
      void unregister​(java.lang.String themeId)
      Unregisters a theme, removing it from the themes registry.

    • Method Detail

      • register

        void register​(java.lang.String themePath)
       throws PortalException
        Registers a theme in the specified classpath relative path.

        The theme will be added or updated in the themes registry.

        Parameters:
        themePath - the relative path in the classpath, referencing the folder that contains the themedefintion.xml file.
        Throws:
        PortalException - if an error occurs during register.
        Since:
        7.0.0

      • unregister

        void unregister​(java.lang.String themeId)
         throws PortalException
        Unregisters a theme, removing it from the themes registry.
        Parameters:
        themeId - the theme identifier.
        Throws:
        PortalException - if an error occurs during unregister.
        Since:
        7.0.0

      • getTheme

        IThemeSPI getTheme​(java.lang.String themeId)
            throws PortalException
        Returns the theme with the given identifier.
        Parameters:
        themeId - the theme identifier.
        Returns:
        the theme.
        Throws:
        PortalObjectNotFoundException - if no theme exists with the given identifier.
        PortalException - if an error occurred while obtaining the theme.
        Since:
        7.0.0

      • getAllThemes

        java.util.Collection<ITheme> getAllThemes()
                                   throws PortalException
        Returns all registered themes
        Returns:
        a list of all registered themes
        Throws:
        PortalException
        Since:
        8.0.0