Interface UICallbackContext


public interface UICallbackContext
Defines the UI Callback context of the custom step.
Since:
2.0.0
  • Method Details

    • getUserOption

      <T extends UserOption> T getUserOption()
      Gets the current user defined option.
      Type Parameters:
      T - The user option type.
      Returns:
      The user defined option.
    • getStepPropertyValue

      <T> Optional<T> getStepPropertyValue(String stepPropertyId)
      Convenience method to get step property value when the user option type is DefaultOption type.
      Type Parameters:
      T - The type of value the step property would return. e.g StringStepProperty would return String value.
      Parameters:
      stepPropertyId - the step property id
      Returns:
      The step property value.
    • isInputNodeConnected

      boolean isInputNodeConnected(String inputId)
      Gets whether the input node, specified by inputId, is connected or not.
      Parameters:
      inputId - The input id
      Returns:
      true if the input is connected, otherwise false
    • getStepSettingFieldValueAsString

      Optional<String> getStepSettingFieldValueAsString(String stepSettingFieldId)
      Returns the step setting field value as a string based on the step setting field ID specified.
      Parameters:
      stepSettingFieldId - ID of the step setting field to be returned
      Returns:
      String value of the step setting field
      Since:
      2.1.0