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

Interface StepProperty<T>

Type Parameters:
T - The type of value this step property use
All Known Subinterfaces:
BooleanStepProperty, ColumnChooserStepProperty, CustomChooserStepProperty, InputLabelStepProperty, InputTextStepProperty<T>, NumberStepProperty, StringStepProperty
public interface StepProperty<T>
Defines the property of a step configured in a workflow. A step property is linked from UI (Data Studio) to UserOption through 2 methods here:
Since:
2.0.0

  • Method Summary

    Modifier and Type
    Method
    Description
    com.experian.datastudio.sdk.api.step.configuration.StepPropertyConfig
    createConfig()
    Creates a StepPropertyConfig to be used to render the step UI.
    default Optional<T>
    getDefaultValue()
    Gets the default value.
    default Optional<T>
    getDefaultValue(DefaultValueContext context)
    Gets the default value.
    String
    getId()
    Gets the step property id.
    Optional<T>
    getValue(UICallbackContext context)
    Gets the value from the UserOption, via context.getUserOption(), to be used in rendering UI.
    default boolean
    hasDefaultValue()
    Specifies whether this property has default value defined or not.
    default boolean
    isDisabled(UICallbackContext context)
    Specifies whether this property is disabled or not.
    boolean
    isRequired()
    Specifies whether this property is required to defined or not.
    UserOption
    onValueChanged(UserOption oldOption, T value)
    Updates the option by creating a new UserOption based on the previous state and a new value from UI.
    default 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 for 'opting out' of re-indexing for performance reasons
    List<String>
    validateState(UICallbackContext context)
    Validates the state of this property (e,g: the value) and return error messages if invalid.

  • Method Details

    • getId

      String getId()
      Gets the step property id.
      Returns:
      the id.

    • onValueChanged

      UserOption onValueChanged(UserOption oldOption, T value)
      Updates the option by creating a new UserOption based on the previous state and a new value from UI.
      Parameters:
      oldOption - the old UserOption
      value - the new value
      Returns:
      the new UserOption

    • getValue

      Optional<T> getValue(UICallbackContext context)
      Gets the value from the UserOption, via context.getUserOption(), to be used in rendering UI.
      Parameters:
      context - the UI context from where the UserOption could be retrieved.
      Returns:
      The value.

    • getDefaultValue

      default Optional<T> getDefaultValue()
      Gets the default value.
      Returns:
      the value.

    • getDefaultValue

      default Optional<T> getDefaultValue(DefaultValueContext context)
      Gets the default value.
      Parameters:
      context - the context from where the UserOption could be retrieved.
      Returns:
      The value.
      Since:
      2.4.0

    • hasDefaultValue

      default boolean hasDefaultValue()
      Specifies whether this property has default value defined or not.
      Returns:
      true if required, otherwise false.

    • createConfig

      com.experian.datastudio.sdk.api.step.configuration.StepPropertyConfig createConfig()
      Creates a StepPropertyConfig to be used to render the step UI.
      Returns:
      the config.

    • isRequired

      boolean isRequired()
      Specifies whether this property is required to defined or not.
      Returns:
      true if required, otherwise false.

    • validateState

      List<String> validateState(UICallbackContext context)
      Validates the state of this property (e,g: the value) and return error messages if invalid.
      Parameters:
      context - the UI context from where the UserOption could be retrieved.
      Returns:
      List of error messages if this step property is invalid.

    • isDisabled

      default boolean isDisabled(UICallbackContext context)
      Specifies whether this property is disabled or not.
      Parameters:
      context - the UI context from where the UserOption could be retrieved.
      Returns:
      true if disabled, otherwise false.

    • shouldRebuildIndex

      default 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 for 'opting out' of re-indexing for performance reasons
      Returns:
      true if index should be rebuilt, otherwise false.