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

Interface StepConfiguration

public interface StepConfiguration
Defines the custom step nodes, step properties, output layout and settings. Generated by StepConfigurationBuilder

One of the 3 main builders required for a custom step:

  1. StepConfigurationBuilder
  2. StepProcessorBuilder
  3. CustomTypeMetadataBuilder
Since:
2.0.0
See Also:

  • Method Details

    • getStepProperties

      List<StepProperty> getStepProperties()
      Returns the step properties that are associated with the custom step.
      Returns:
      List of Step Properties

    • getDefaultStepOptions

      UserOption getDefaultStepOptions()
      Returns the default configuration option of the custom step.
      Returns:
      User option

    • getOutputLayouts

      List<OutputLayout> getOutputLayouts()
      Returns the output layout of the custom step.
      Returns:
      List of output layouts

    • getInputNode

      List<InputNode> getInputNode()
      Returns the input nodes that are associated with the custom step.
      Returns:
      List of input Node Definitions

    • getOutputNode

      List<OutputNode> getOutputNode()
      Returns the output nodes that are associated with the custom step.
      Returns:
      List of output Node Definitions

    • isComplete

      boolean isComplete(UICallbackContext context)
      Returns a flag to determine if the custom step is complete.
      Parameters:
      context - the UI context from where the value of StepProperty could be retrieved.
      Returns:
      true if the custom step is complete, otherwise false

    • getStepSetting

      Optional<CustomStepSetting> getStepSetting()
      Returns step setting of the custom step.
      Returns:
      Custom step setting

    • getIcon

      StepIcon getIcon()
      Returns the icon of the custom step.
      Returns:
      step icon