com.haulmont.cuba.security.app

Interface UserSettingService

All Known Implementing Classes:

UserSettingServiceBean

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.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME

Method Summary

Modifier and Type	Method and Description
void	copySettings(User fromUser, User toUser) Copy user settings to another user
void	deleteScreenSettings(ClientType clientType, java.util.Set<java.lang.String> screens) Delete settings of screens (settings of tables, filters etc) for the current user.
void	deleteSettings(ClientType clientType, java.lang.String name) Delete settings for the current user
java.lang.String	loadSetting(ClientType clientType, java.lang.String name) Load 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(ClientType clientType, java.lang.String name, java.lang.String value) Save settings for the current user
void	saveSetting(java.lang.String name, java.lang.String value) Save settings for the current user and null client type

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

Method Detail

loadSetting

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.

loadSetting

java.lang.String loadSetting(ClientType clientType,
                             java.lang.String name)

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

saveSetting

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

Save settings for the current user and null client type

saveSetting

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

Save settings for the current user

deleteSettings

void deleteSettings(ClientType clientType,
                    java.lang.String name)

Delete settings for the current user

copySettings

void copySettings(User fromUser,
                  User toUser)

Copy user settings to another user

deleteScreenSettings

void deleteScreenSettings(ClientType clientType,
                          java.util.Set<java.lang.String> screens)

Delete settings of screens (settings of tables, filters etc) for the current user.

Parameters:

clientType - client type

screens - set of window ids, whose settings must be deleted