Interface UserSettingsService

public interface UserSettingsService

  • Method Details

    • getSetting

      String getSetting(String username, UserSettingsService.UserSetting setting)
      Pobiera wartość podanego ustawienia użytkownika.
      Parameters:
      setting - Ustawienie użytkownika, które chcemy odczytać
      Returns:
      Wartość tego ustawienia lub null, jeżeli użytkownik nie posiada takiego ustawienia

    • getSetting

      String getSetting(String username, String settingName)
      Pobiera wartość podanego ustawienia użytkownika.
      Parameters:
      username - Nazwa użytkownika, którego ustawienie chcemy odczytać
      settingName - Nazwa ustawienia użytkownika
      Returns:
      Wartość tego ustawienia lub null, jeżeli użytkownik nie posiada takiego ustawienia

    • getSettings

      Map<String,String> getSettings(String username)
      Pobiera wszystkie ustawienia użytkownika
      Parameters:
      username - Nazwa użytkownika, którego ustawienia chcemy odczytać
      Returns:
      Mapa ustawień, kluczem jest nazwa ustawienia

    • setUserSetting

      void setUserSetting(String username, UserSettingsService.UserSetting setting, String value) throws UserNotFoundException
      Dodaje podane ustawienie dla podanego użytkownika. Wartość starego ustawienia zostanie nadpisana.
      Parameters:
      username - Nazwa użytkownika, któremu dodajemy ustawienie
      value - Wartość tego ustawienia
      settingName - Ustawienie
      Throws:
      UserNotFoundException - Użytkownik o podanej nazwie nie został znaleziony w systemie

    • setUserSetting

      void setUserSetting(String username, String settingName, String value) throws UserNotFoundException
      Dodaje podane ustawienie dla podanego użytkownika. Wartość starego ustawienia zostanie nadpisana.
      Parameters:
      username - Nazwa użytkownika, któremu dodajemy ustawienie
      settingName - Nazwa ustawienia
      value - Wartość tego ustawienia
      Throws:
      UserNotFoundException - Użytkownik o podanej nazwie nie został znaleziony w systemie

    • setUserSetting

      void setUserSetting(String username, Map<String,String> settings) throws UserNotFoundException
      Ustawia wszystkie ustawienia użytkownika na podstawie podanej mapy.
      Parameters:
      username - Nazwa użytkownika, którego ustawienia zmieniamy
      settings - Mapa ustawień, kluczem jest nazwa ustawienia
      Throws:
      UserNotFoundException - Użytkownik o podanej nazwie nie został znaleziony w systemie

    • setUserSetting

      void setUserSetting(User user, Map<String,String> settings)
      Ustawia wszystkie ustawienia użytkownika na podstawie podanej mapy.
      Parameters:
      user - Użytkownik, którego ustawienia zmieniamy
      settings - Mapa ustawień, kluczem jest nazwa ustawienia
      Throws:
      UserNotFoundException - Użytkownik o podanej nazwie nie został znaleziony w systemie

    • setUserSetting

      void setUserSetting(User user, String settingName, String value)
      Dodaje podane ustawienie dla podanego użytkownika. Wartość starego ustawienia zostanie nadpisana.
      Parameters:
      user - Użytkownik, któremu dodajemy ustawienie
      settingName - Nazwa ustawienia
      value - Wartość tego ustawienia

    • deleteUserSetting

      void deleteUserSetting(String username, UserSettingsService.UserSetting setting)
      Usuwa podane ustawienie użytkownika
      Parameters:
      username - Nazwa użytkownika
      setting - Ustawienie, które chcemy usunąć

    • deleteUserSetting

      void deleteUserSetting(String username, String settingName)
      Usuwa podane ustawienie użytkownika
      Parameters:
      username - Nazwa użytkownika
      settingName - Nazwa ustawienia, które chcemy usunąć

    • deleteUserSettings

      void deleteUserSettings(String username)
      Usuwa wszystkie ustawienia podanego użytkownika.
      Parameters:
      username - Nazwa użytkownika

    • getUserLocale

      Locale getUserLocale(String username)
      Odczytuje ustawienia językowe użytkownika.
      Parameters:
      username - Nazwa użytkownika, którego ustawienia językowe odczytujemy
      Returns:
      Locale użytkownika lub null, jeżeli użytkownik używa domyślnych ustawień.

    • getUserPageSize

      int getUserPageSize(String username)
      Odczytuje ilość wyświetlanych pozycji na stronie w tabeli. Domyślną wartością jest 20.

    • getSkinForUser

      Skin getSkinForUser(String username)
      Odczytuje skórkę użytkownika.
      Parameters:
      username - Nazwa użytkownika dla którego odczytujemy skórkę
      Returns:
      Ustawiona skórka użytkownika lub domyślna skórka systemu, jeżeli użytkownik żadnej nie ustawił.

    • getDefaultSkin

      Skin getDefaultSkin()
      Odczytuje domyślną skórkę w systemie.
      Returns:
      Domyślna skórka.

    • getDefaultUserViews

      List<com.suncode.plugin.framework.defaultView.DefaultView> getDefaultUserViews(String username)
      Zwraca możliwe do wyboru domyślne widoki dla użytkownika
      Parameters:
      username - login użytkownika
      Returns:
      widoki do wyboru

    • getSkinPathForUser

      String getSkinPathForUser(String username)
      Odczytuje nazwę skórki użytkownika.
      Parameters:
      username - Nazwa użytkownika dla którego odczytujemy skórkę
      Returns:
      Ustawiona skórka użytkownika lub domyślna skórka systemu, jeżeli użytkownik żadnej nie ustawił.

    • isDarkSkin

      boolean isDarkSkin(String username)
      Sprawdza czy użytkownik wybrał ciemną skórkę
      Parameters:
      username - Nazwa użytkownika dla którego odczytujemy skórkę
      Returns:
      czy ustawiona skórka ciemna

    • isHighContrastSkin

      boolean isHighContrastSkin(String username)
      Sprawdza czy użytkownik wybrał skórkę wysoki kontrast
      Parameters:
      username - Nazwa użytkownika dla którego odczytujemy skórkę
      Returns:
      czy ustawiona skórka wysoki kontrast

    • invalidateSettingsCache

      void invalidateSettingsCache()
      Odświeża cache ustawień użytkowników.