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

Interface ParameterDefinition

public interface ParameterDefinition
Parameter definition of a custom parser Used by ParameterDefinitionBuilder
Since:
2.0.0

  • Method Details

    • getId

      String getId()
      Returns the ID of the parameter definition.
      Returns:
      ID of the parameter definition

    • getName

      String getName()
      Returns the name of the parameter definition.
      Returns:
      Name of the parameter definition

    • getDescription

      String getDescription()
      Returns the description of the parameter definition.
      Returns:
      Description of the parameter definition

    • isRequired

      boolean isRequired()
      Returns the necessity of the parameter definition.
      Returns:
      Necessity of the parameter definition

    • getType

      ParserParameterValueType getType()
      Returns the parameter type of the parameter definition.
      Returns:
      Parameter value type of the parameter definition

    • getUIType

      ParserParameterDisplayType getUIType()
      Returns the display type of the parameter definition.
      Returns:
      Parameter display type of the parameter definition

    • getCustomSelectionUIType

      ParserParameterCustomSelectionType getCustomSelectionUIType()
      Return the custom selection display type of the parameter definition
      Returns:
      custom display type of the parameter definition
      Since:
      2.6.0

    • getAllowedValues

      List<String> getAllowedValues()
      Return the available values for selection in the custom selection UI
      Returns:
      available values for selection in the custom selection UI
      Since:
      2.6.0

    • getDefaultValue

      Object getDefaultValue(ParameterContext parameterContext)
      Returns the default parameter value as a string.
      Parameters:
      parameterContext - the parameter context of the custom parser
      Returns:
      Default string value

    • affectsTableStructure

      boolean affectsTableStructure()
      Returns the flag for table structure changes.
      Returns:
      Flag for table structure changes