Package wt.preference

Interface MultiValuedPreferenceHandler

All Superinterfaces:

PreferenceValueHandler

public interface MultiValuedPreferenceHandler
extends PreferenceValueHandler

PreferenceValueHandler extension to support MultiValuedPreferenceInstance object. This interface implementation is more towards exchanging the MultiValuedPreferenceInstance objects through loaders and Export import preference utility.

Supported API: true

Extendable: true

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	getValue(Map<String,Object> map)	This method is used to provide Database values which can be persisted as per Target system information for MultiValuedPreferenceInstance object attributes like VALUEKEY and VALUEVALUE.
default String	getValueKey(MultiValuedPreferenceInstance instance)	This method provides an option to parse the information of _MultiValuedPreferenceInstance.getValueKey() to make it more readable or exportable information.
default String	getValueValue(MultiValuedPreferenceInstance instance)	This method provides an option to parse the information of _MultiValuedPreferenceInstance.getValueValue() to make it more readable or exportable information.
default boolean	isMultiMapPreference()	Determines if the preference value handler manages more than one key value pair for one preference.

Methods inherited from interface wt.preference.PreferenceValueHandler

getEditGuiComponent, getValue, getValue, getValue, getValue, getViewGuiComponent, getViewGuiComponent, initialize, isMultiPreference, isValueChanged, multiPreferences, objectClass, objectToString, process, stringToObject, stringToObject, validate, validate

Method Details

getValue

Map<String,Object> getValue(Map<String,Object> map)
                     throws WTException

This method is used to provide Database values which can be persisted as per Target system information for MultiValuedPreferenceInstance object attributes like VALUEKEY and VALUEVALUE. Supported API: true

Parameters:

map - This consists of in-memory MultiValuedPreferenceInstance objects against a predefined key #MV_PREFERENCE_INST_SET

Returns:

Map of updated instances with database storing values. Key should be #MV_PREFERENCE_INST_SET

Throws:

WTException

getValueKey

default String getValueKey(MultiValuedPreferenceInstance instance)
                    throws WTException

This method provides an option to parse the information of _MultiValuedPreferenceInstance.getValueKey() to make it more readable or exportable information. Supported API: true
This has default implementation to provide plain value present in database against VALUEKEY column.

Parameters:

instance - - MultiValuedPreferenceInstance object

Returns:

- String value which is parsed information of _MultiValuedPreferenceInstance.getValueKey().

Throws:

WTException

getValueValue

default String getValueValue(MultiValuedPreferenceInstance instance)
                      throws WTException

This method provides an option to parse the information of _MultiValuedPreferenceInstance.getValueValue() to make it more readable or exportable information. Supported API: true
This has default implementation to provide plain value present in database against VALUEVALUE column.

Parameters:

instance - MultiValuedPreferenceInstance object

Returns:

- String value which is parsed information of _MultiValuedPreferenceInstance.getValueValue().

Throws:

WTException

isMultiMapPreference

default boolean isMultiMapPreference()

Determines if the preference value handler manages more than one key value pair for one preference. Note: Do not override this API

Supported API: true

Specified by:

isMultiMapPreference in interface PreferenceValueHandler

Returns:

boolean