Package org.hippoecm.hst.configuration.components

Interface DynamicParameter

public interface DynamicParameter

  • Method Details

    • getName

      String getName()
      Returns:
      the name of the parameter used

    • isRequired

      boolean isRequired()
      Returns:
      true if this is a required parameter

    • getDefaultValue

      String getDefaultValue()
      Returns:
      the default value of this parameter

    • getDisplayName

      String getDisplayName()
      Returns:
      the displayName of this parameter. This can be the 'pretty' name for getName(). If missing, implementations can do a fallback to getName()

    • isHideInChannelManager

      boolean isHideInChannelManager()
      Returns:
      true if the parameter should not be shown in the channel manager UI

    • getValueType

      ParameterValueType getValueType()
      Returns:
      the type of the parameter

    • isResidual

      boolean isResidual()
      Returns:
      true if this is a residual parameter

    • getComponentParameterConfig

      DynamicParameterConfig getComponentParameterConfig()
      Returns:
      the parameter config of the parameter if present, null otherwise