Package com.experian.datastudio.sdk.api.step.configuration.stepproperties

Interface CustomChooserStepProperty

All Superinterfaces:

StepProperty<List<String>>

public interface CustomChooserStepProperty
extends StepProperty<List<String>>

Step property that provides a custom chooser for user to select an input. Used by CustomChooserStepPropertyBuilder

Since:

2.0.0

Method Summary

Modifier and Type	Method	Description
BiFunction<UICallbackContext,CustomChooserItemBuilder,List<CustomChooserItem>>	getAllowedChooserItemsProvider()	Returns the allowed provider from which chooser items will be used populate the column chooser
Function<UICallbackContext,List<String>>	getAllowedValuesProvider()	Deprecated. Since 2.3.0.
boolean	isMultipleSelectEnabled()	Returns the ability for a user to select multiple values from the custom chooser.
boolean	isSearchEnabled()	Returns the ability for a user to search of a specified value in the custom chooser.
boolean	isSelectAllEnabled()	Returns the ability for a user to select all values from the custom chooser.

Methods inherited from interface com.experian.datastudio.sdk.api.step.configuration.StepProperty

createConfig, getDefaultValue, getDefaultValue, getId, getValue, hasDefaultValue, isDisabled, isRequired, onValueChanged, shouldRebuildIndex, validateState

Method Details

getAllowedValuesProvider

@Deprecated
Function<UICallbackContext,List<String>> getAllowedValuesProvider()

Deprecated.

Since 2.3.0. Replaced by {getAllowedChooserItemsProvider()}

Returns the allowed provider from which values will be used populate the column chooser

Returns:

Callback that returns a list of allowed values

getAllowedChooserItemsProvider

BiFunction<UICallbackContext,CustomChooserItemBuilder,List<CustomChooserItem>> getAllowedChooserItemsProvider()

Returns the allowed provider from which chooser items will be used populate the column chooser

Returns:

Callback that returns a list of allowed chooser items

Since:

2.3.0

isMultipleSelectEnabled

boolean isMultipleSelectEnabled()

Returns the ability for a user to select multiple values from the custom chooser.

Returns:

Flag of ability for multiple value selection

isSelectAllEnabled

boolean isSelectAllEnabled()

Returns the ability for a user to select all values from the custom chooser.

Returns:

Flag of ability for selection of all values

isSearchEnabled

boolean isSearchEnabled()

Returns the ability for a user to search of a specified value in the custom chooser.

Returns:

Flag of ability for search of specified value