Interface UICallbackContext
public interface UICallbackContext
Defines the UI Callback context of the custom step.
- Since:
- 2.0.0
-
Method Summary
Modifier and TypeMethodDescription<T> Optional<T>
getStepPropertyValue
(String stepPropertyId) Convenience method to get step property value when the user option type isDefaultOption
type.getStepSettingFieldValueAsString
(String stepSettingFieldId) Returns the step setting field value as a string based on the step setting field ID specified.<T extends UserOption>
TGets the current user defined option.boolean
isInputNodeConnected
(String inputId) Gets whether the input node, specified byinputId
, is connected or not.
-
Method Details
-
getUserOption
Gets the current user defined option.- Type Parameters:
T
- The user option type.- Returns:
- The user defined option.
-
getStepPropertyValue
Convenience method to get step property value when the user option type isDefaultOption
type.- Type Parameters:
T
- The type of value the step property would return. e.gStringStepProperty
would returnString
value.- Parameters:
stepPropertyId
- the step property id- Returns:
- The step property value.
-
isInputNodeConnected
Gets whether the input node, specified byinputId
, is connected or not.- Parameters:
inputId
- The input id- Returns:
true
if the input is connected, otherwisefalse
-
getStepSettingFieldValueAsString
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
-