Interface UserOption
public interface UserOption
User defined step options to pass in the value of StepConfiguration into Data Studio.
StepConfiguration values are stored inside UserOptions.
- Since:
- 2.0.0
-
Method Summary
Modifier and TypeMethodDescriptionboolean
Returns a flag to determine if the custom step has no operation.Map old column IDs to new column IDsboolean
Returns a flag to determine if the custom step requires column reconciliation.retrieveReferencedColumnIds
(String inputLabel) Returns the referenced column IDs.default Collection<String>
Retrieves all referenced workflow parameters.Validate changes to the options.default UserOption
validateParameterReferences
(Set<String> validParameterIds) Validate parameter references, removing the reference from option if it's not invalidParameterIds
.
-
Method Details
-
hasNoOperation
boolean hasNoOperation()Returns a flag to determine if the custom step has no operation.- Returns:
true
if the custom step has no operation, otherwisefalse
-
requiresColumnReconciliation
boolean requiresColumnReconciliation()Returns a flag to determine if the custom step requires column reconciliation.- Returns:
true
if the custom step requires column reconciliation, otherwisefalse
-
mapIds
Map old column IDs to new column IDs- Parameters:
inputToIdMap
- Input to ID map- Returns:
UserOption
object
-
retrieveReferencedColumnIds
Returns the referenced column IDs.- Parameters:
inputLabel
- Input label- Returns:
- Collection of referenced column IDs
-
validate
UserOption validate(Map<String, List<String>> oldInputColumns, Map<String, List<String>> newInputColumns) Validate changes to the options. e.g. If input column no longer has certain column ID, remove it- Parameters:
oldInputColumns
- Old input columnsnewInputColumns
- New input columns- Returns:
- UserOption object
-
validateParameterReferences
Validate parameter references, removing the reference from option if it's not invalidParameterIds
.- Parameters:
validParameterIds
- Valild parameter ids- Returns:
- Updated Useroption
-
retrieveReferencedParameters
Retrieves all referenced workflow parameters.- Returns:
- list of referenced parameters.
-