Package io.jmix.ui.settings

Interface UserSettingService

All Known Implementing Classes:
UserSettingServiceImpl
public interface UserSettingService
Service providing current user settings functionality: an application can save/load some "setting" (plain or XML string) for current user.
It is usually used by UI forms and components.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    copySettings(org.springframework.security.core.userdetails.UserDetails fromUser, org.springframework.security.core.userdetails.UserDetails toUser)
    Copy user settings to another user
    void
    deleteScreenSettings(Set<String> screens)
    Delete settings of screens (settings of tables, filters etc) for the current user.
    void
    deleteSettings(String name)
    Delete settings for the current user
    String
    loadSetting(String name)
    Load settings for the current user and null client type.
    void
    saveSetting(String name, String value)
    Save settings for the current user and null client type

  • Method Details

    • loadSetting

      @Nullable String loadSetting(String name)
      Load settings for the current user and null client type. Returns null if no such setting found.

    • saveSetting

      void saveSetting(String name, @Nullable String value)
      Save settings for the current user and null client type

    • deleteSettings

      void deleteSettings(String name)
      Delete settings for the current user

    • copySettings

      void copySettings(org.springframework.security.core.userdetails.UserDetails fromUser, org.springframework.security.core.userdetails.UserDetails toUser)
      Copy user settings to another user

    • deleteScreenSettings

      void deleteScreenSettings(Set<String> screens)
      Delete settings of screens (settings of tables, filters etc) for the current user.
      Parameters:
      screens - set of window ids, whose settings must be deleted