org.uberfire.preferences.shared.bean

Interface PreferenceBeanServerStore

All Superinterfaces:

PreferenceBeanStore

public interface PreferenceBeanServerStore
extends PreferenceBeanStore

Service to manage preference beans.

Method Summary

Modifier and Type	Method and Description
PreferenceHierarchyElement<?>	buildHierarchyStructureForPreference(String identifier) Builds a tree hierarchy that begins with the root preference bean which identifier was passed and grows based on their sub-preferences.
PreferenceHierarchyElement<?>	buildHierarchyStructureForPreference(String identifier, PreferenceScopeResolutionStrategyInfo scopeResolutionStrategyInfo) Builds a tree hierarchy that begins with the root preference bean which identifier was passed and grows based on their sub-preferences.
<U extends BasePreference<U>,T extends BasePreferencePortable<U>> T	load(T emptyPortablePreference) Loads all preference bean properties.
<U extends BasePreference<U>,T extends BasePreferencePortable<U>> T	load(T emptyPortablePreference, PreferenceScopeResolutionStrategyInfo scopeResolutionStrategyInfo) Loads all preference bean properties, following the passed scope resolution strategy.
void	save(Collection<BasePreferencePortable<? extends BasePreference<?>>> portablePreferences) Saves all preferences passed.
void	save(Collection<BasePreferencePortable<? extends BasePreference<?>>> portablePreferences, PreferenceScope scope) Saves all preferences passed, following the passed scope resolution strategy.
void	save(Collection<BasePreferencePortable<? extends BasePreference<?>>> portablePreferences, PreferenceScopeResolutionStrategyInfo scopeResolutionStrategyInfo) Saves all preferences passed, following the passed scope resolution strategy.
<U extends BasePreference<U>,T extends BasePreferencePortable<U>> void	save(T portablePreference) Saves all preference data.
<U extends BasePreference<U>,T extends BasePreferencePortable<U>> void	save(T portablePreference, PreferenceScope scope) Saves all preference data, inside the passed scope.
<U extends BasePreference<U>,T extends BasePreferencePortable<U>> void	save(T portablePreference, PreferenceScopeResolutionStrategyInfo scopeResolutionStrategyInfo) Saves all preference data, following the passed scope resolution strategy.

Methods inherited from interface org.uberfire.preferences.shared.bean.PreferenceBeanStore

load, load, save, save, save, save, save, save

Method Detail

load

<U extends BasePreference<U>,T extends BasePreferencePortable<U>> T load(T emptyPortablePreference)

Loads all preference bean properties.

Type Parameters:

U - Preference bean type.

T - Preference bean generated portable type.

Parameters:

emptyPortablePreference - Newly created portable instance for the preference bean.

Returns:

A loaded preference bean portable instance.

load

<U extends BasePreference<U>,T extends BasePreferencePortable<U>> T load(T emptyPortablePreference,
                                                                         PreferenceScopeResolutionStrategyInfo scopeResolutionStrategyInfo)

Loads all preference bean properties, following the passed scope resolution strategy.

Type Parameters:

U - Preference bean type.

T - Preference bean generated portable type.

Parameters:

emptyPortablePreference - Newly created portable instance for the preference bean.

scopeResolutionStrategyInfo - Custom scope resolution strategy to follow.

Returns:

A loaded preference bean portable instance.

save

<U extends BasePreference<U>,T extends BasePreferencePortable<U>> void save(T portablePreference)

Saves all preference data.

Type Parameters:

U - Preference bean type.

T - Preference bean generated portable type.

Parameters:

portablePreference - Preference instance to be saved.

save

<U extends BasePreference<U>,T extends BasePreferencePortable<U>> void save(T portablePreference,
                                                                            PreferenceScopeResolutionStrategyInfo scopeResolutionStrategyInfo)

Saves all preference data, following the passed scope resolution strategy.

Type Parameters:

U - Preference bean type.

T - Preference bean generated portable type.

Parameters:

portablePreference - Preference instance to be saved.

scopeResolutionStrategyInfo - Custom scope resolution strategy to follow.

save

<U extends BasePreference<U>,T extends BasePreferencePortable<U>> void save(T portablePreference,
                                                                            PreferenceScope scope)

Saves all preference data, inside the passed scope.

Type Parameters:

U - Preference bean type.

T - Preference bean generated portable type.

Parameters:

portablePreference - Preference instance to be saved.

scope - Custom scope inside which the preference should be saved.

save

void save(Collection<BasePreferencePortable<? extends BasePreference<?>>> portablePreferences)

Saves all preferences passed.

Parameters:

portablePreferences - Preference instances to be saved.

save

void save(Collection<BasePreferencePortable<? extends BasePreference<?>>> portablePreferences,
          PreferenceScopeResolutionStrategyInfo scopeResolutionStrategyInfo)

Saves all preferences passed, following the passed scope resolution strategy.

Parameters:

portablePreferences - Preference instances to be saved.

scopeResolutionStrategyInfo - Custom scope resolution strategy to follow.

save

void save(Collection<BasePreferencePortable<? extends BasePreference<?>>> portablePreferences,
          PreferenceScope scope)

Saves all preferences passed, following the passed scope resolution strategy.

Parameters:

portablePreferences - Preference instances to be saved.

scope - Custom scope resolution strategy to follow.

buildHierarchyStructureForPreference

PreferenceHierarchyElement<?> buildHierarchyStructureForPreference(String identifier)

Builds a tree hierarchy that begins with the root preference bean which identifier was passed and grows based on their sub-preferences.

Parameters:

identifier - Root preference identifier. Must not be null.

Returns:

A tree hierarchy between all preference beans.

buildHierarchyStructureForPreference

PreferenceHierarchyElement<?> buildHierarchyStructureForPreference(String identifier,
                                                                   PreferenceScopeResolutionStrategyInfo scopeResolutionStrategyInfo)

Builds a tree hierarchy that begins with the root preference bean which identifier was passed and grows based on their sub-preferences.

Parameters:

identifier - Root preference identifier. Must not be null.

scopeResolutionStrategyInfo - Custom scope resolution strategy to follow.

Returns:

A tree hierarchy between all preference beans.