Interface VariableTemplate


  • @ProviderType
    public interface VariableTemplate
    Interface for the schema information of the variables
    • Method Detail

      • getDescription

        String getDescription()
        Returns the variable's description
        Returns:
      • setDescription

        void setDescription​(String description)
        Sets the variable's description
        Parameters:
        description -
      • getType

        String getType()
        Returns the type of the variable. It is in JAVA FQN format.
        Returns:
      • setType

        void setType​(String type)
        Sets the type of the variable.
        Parameters:
        type - in java fqn format
      • getName

        String getName()
        Returns the name of the variable.
        Returns:
      • setName

        void setName​(String name)
        Sets the name of the variable. It is expected to be the unique identifier of the variable.
        Parameters:
        name -
      • getSubType

        String getSubType()
        Returns the subType of the variable. Relevant in case of Collection type variable.
        Returns:
      • setSubType

        void setSubType​(String subType)
        Sets the subType of the variable. Relevant in case of Collection type variable.
        Parameters:
        subType -
      • setDefaultValue

        void setDefaultValue​(Object defaultValue)
        Sets the default value of the variable.
        Parameters:
        defaultValue -
      • getDefaultValue

        Object getDefaultValue()
        Returns the default value of the variable
        Returns:
      • getAdditionalProperties

        Map<String,​String> getAdditionalProperties()
        Returns Map of additional properties of the variable set during authoring.
        Returns: