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 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, otherwise false
    • requiresColumnReconciliation

      boolean requiresColumnReconciliation()
      Returns a flag to determine if the custom step requires column reconciliation.
      Returns:
      true if the custom step requires column reconciliation, otherwise false
    • mapIds

      UserOption mapIds(Map<String,Map<String,String>> inputToIdMap)
      Map old column IDs to new column IDs
      Parameters:
      inputToIdMap - Input to ID map
      Returns:
      UserOption object
    • retrieveReferencedColumnIds

      Collection<String> retrieveReferencedColumnIds(String inputLabel)
      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 columns
      newInputColumns - New input columns
      Returns:
      UserOption object
    • validateParameterReferences

      default UserOption validateParameterReferences(Set<String> validParameterIds)
      Validate parameter references, removing the reference from option if it's not in validParameterIds.
      Parameters:
      validParameterIds - Valild parameter ids
      Returns:
      Updated Useroption
    • retrieveReferencedParameters

      default Collection<String> retrieveReferencedParameters()
      Retrieves all referenced workflow parameters.
      Returns:
      list of referenced parameters.