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 and 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(java.util.Set<java.lang.String> screens) Delete settings of screens (settings of tables, filters etc) for the current user.
void	deleteSettings(java.lang.String name) Delete settings for the current user
java.lang.String	loadSetting(java.lang.String name) Load settings for the current user and null client type.
void	saveSetting(java.lang.String name, java.lang.String value) Save settings for the current user and null client type

Method Detail

loadSetting

@Nullable
java.lang.String loadSetting(java.lang.String name)

Load settings for the current user and null client type. Returns null if no such setting found.

saveSetting

void saveSetting(java.lang.String name,
                 @Nullable
                 java.lang.String value)

Save settings for the current user and null client type

deleteSettings

void deleteSettings(java.lang.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(java.util.Set<java.lang.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