Interface BackofficeThemeService

All Known Implementing Classes:
DefaultBackofficeThemeService

public interface BackofficeThemeService
Service used to set the theme used by backoffice or get the theme currently used by backoffice
  • Method Details

    • getCurrentTheme

      @NotNull @NotNull ThemeModel getCurrentTheme()
      Get current theme.
      Returns:
      the current theme
    • getCurrentUserTheme

      @NotNull @NotNull ThemeModel getCurrentUserTheme()
      Get the theme in user level.
      Returns:
      the theme in user level
    • setCurrentUserTheme

      void setCurrentUserTheme(@NotNull @NotNull String code) throws ThemeNotFound
      Set the theme in user level.
      Parameters:
      code - theme code
      Throws:
      ThemeNotFound
    • getSystemTheme

      @NotNull @NotNull ThemeModel getSystemTheme()
      Get the theme in system level.
      Returns:
      the theme in system level
    • setSystemTheme

      void setSystemTheme(@NotNull @NotNull String code) throws ThemeNotFound
      Set the theme in system level.
      Parameters:
      code - theme code
      Throws:
      ThemeNotFound
    • getAvailableThemes

      @NotNull @NotNull List<ThemeModel> getAvailableThemes()
      Get all available themes.
      Returns:
      all available themes
    • getBaseThemes

      @NotNull @NotNull List<ThemeModel> getBaseThemes()
      Get all Backoffice base themes which can be based by customer theme.
      Returns:
      all Backoffice base themes
    • getCustomThemes

      @NotNull @NotNull List<CustomThemeModel> getCustomThemes()
      Get all custom themes.
      Returns:
      all custom themes
    • getDefaultTheme

      @NotNull @NotNull ThemeModel getDefaultTheme()
      Get default theme.
      Returns:
      the default theme
    • getThemeLevel

      @NotNull @NotNull BackofficeThemeLevel getThemeLevel()
      Get theme level.
      Returns:
      the theme level
    • setThemeLevel

      void setThemeLevel(@NotNull @NotNull BackofficeThemeLevel level)
      Set theme level.
      Parameters:
      level - theme level
    • setUserLevelDefaultTheme

      void setUserLevelDefaultTheme(String code) throws ThemeNotFound
      Set default user level theme.
      Parameters:
      code - theme code
      Throws:
      ThemeNotFound
    • getUserLevelDefaultTheme

      @NotNull @NotNull ThemeModel getUserLevelDefaultTheme()
      Get default theme in user level.
      Returns:
      the default theme in user level
    • getMaximumOfCustomTheme

      @NotNull @javax.validation.constraints.NotNull int getMaximumOfCustomTheme()
      Get maximum of custom theme
      Returns:
      maximum of custom theme