Package com.adobe.granite.workflow.model

Interface VariableTemplate

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

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.util.Map<java.lang.String,​java.lang.String> getAdditionalProperties()
      Returns Map of additional properties of the variable set during authoring.
      java.lang.Object getDefaultValue()
      Returns the default value of the variable
      java.lang.String getDescription()
      Returns the variable's description
      java.lang.String getName()
      Returns the name of the variable.
      java.lang.String getSubType()
      Returns the subType of the variable.
      java.lang.String getType()
      Returns the type of the variable.
      void setDefaultValue​(java.lang.Object defaultValue)
      Sets the default value of the variable.
      void setDescription​(java.lang.String description)
      Sets the variable's description
      void setName​(java.lang.String name)
      Sets the name of the variable.
      void setSubType​(java.lang.String subType)
      Sets the subType of the variable.
      void setType​(java.lang.String type)
      Sets the type of the variable.

    • Method Detail

      • getDescription

        java.lang.String getDescription()
        Returns the variable's description
        Returns:

      • setDescription

        void setDescription​(java.lang.String description)
        Sets the variable's description
        Parameters:
        description -

      • getType

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

      • setType

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

      • getName

        java.lang.String getName()
        Returns the name of the variable.
        Returns:

      • setName

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

      • getSubType

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

      • setSubType

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

      • setDefaultValue

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

      • getDefaultValue

        java.lang.Object getDefaultValue()
        Returns the default value of the variable
        Returns:

      • getAdditionalProperties

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