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

Interface StepPropertyBuilder<B,S,V>

Type Parameters:
B - Type of specific concrete step property builder.
S - Type of the concrete step property.
V - Type of value produce by the concrete step property
All Known Subinterfaces:
BooleanStepPropertyBuilder, ColumnChooserStepPropertyBuilder, CustomChooserStepPropertyBuilder, InputTextStepPropertyBuilder<T,V>, NumberStepPropertyBuilder, StringStepPropertyBuilder
public interface StepPropertyBuilder<B,S,V>
Builder that defines the common concrete step property builder methods shared by all Step Properties.
Since:
2.0.0

  • Method Details

    • build

      S build()
      Builds the step property object.
      Returns:
      Step property object

    • withIsDisabledSupplier

      B withIsDisabledSupplier(Predicate<UICallbackContext> disabledSupplier)
      Configures a supplier which determines if this step property should be disabled
      Parameters:
      disabledSupplier - callback that returns a result which determines if this step property should be disabled
      Returns:
      Step property builder

    • withLabelSupplier

      B withLabelSupplier(Function<UICallbackContext,String> labelSupplier)
      Configures a supplier which returns a string label
      Parameters:
      labelSupplier - callback that returns a string label
      Returns:
      Step property builder

    • withValueSupplier

      @Deprecated B withValueSupplier(Function<UICallbackContext,V> valueSupplier)
      Deprecated.
      Since 2.2.0, custom UserOption is not supported, replaced by withOnValueChanged(Consumer)
      Configures a supplier which returns a value produced by the concrete step property
      Parameters:
      valueSupplier - callback that returns a value produced by the concrete step property
      Returns:
      Step property builder

    • withOnValueChanged

      @Deprecated <T extends UserOption> B withOnValueChanged(BiFunction<T,V,T> onValueChanged)
      Deprecated.
      Since 2.2.0, custom UserOption is not supported, replaced by withOnValueChanged(Consumer)
      Configures a callback to update changes when the value changes in the UI
      Type Parameters:
      T - return type
      Parameters:
      onValueChanged - callback to update changes when the value changes in the UI
      Returns:
      Step property builder

    • withOnValueChanged

      B withOnValueChanged(Consumer<StepPropertyOnValueChangedContext> onValueChangedContextConsumer)
      Configures a callback to update other step properties when the value changes
      Parameters:
      onValueChangedContextConsumer - callback to update other step properties when the value changes
      Returns:
      Step property builder
      Since:
      2.2.0

    • withShouldRebuildIndex

      B withShouldRebuildIndex(boolean shouldRebuildIndex)
      Indicates whether to rebuild the index when the property value has changed Default value of rebuildIndex is true - Assume any change to the property value will affect the index by default Allows developers to 'opt out' of re-indexing if they want to do so for performance reasons
      Parameters:
      shouldRebuildIndex - indicates that index should be rebuilt on changes to property value
      Returns:
      Step property builder
      Since:
      2.4.0