Package com.aquima.interactions.composer

Interface IGlobalParameterValue

All Superinterfaces:
Serializable
All Known Implementing Classes:
GlobalParameterValue
public interface IGlobalParameterValue extends Serializable
The (potentially evaluated) value of a global parameter.
Since:
11.3
Author:
Petru Galanton

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getParameterName()
    The name of the parameter whose value is represented by this object.
    GlobalParameterType
    getParameterType()
    The type of the parameter whose value is represented by this object.
    DataType
    getPrimitiveType()
    If the parameter is of type primitive, this method returns the data type of the value.
    IContentItem
    getText()
    If the parameter is of type text, this method returns the content item containing the text.
    IValue
    getValue()
    If the parameter is of type primitive, this method returns the value resulted from evaluating the value expression.

  • Method Details

    • getParameterName

      String getParameterName()
      The name of the parameter whose value is represented by this object.
      Returns:
      the parameter name, never null.

    • getParameterType

      GlobalParameterType getParameterType()
      The type of the parameter whose value is represented by this object.
      Returns:
      the parameter type, never null.

    • getPrimitiveType

      DataType getPrimitiveType()
      If the parameter is of type primitive, this method returns the data type of the value. If the parameter is of type text, this method returns null.
      Returns:
      the data type of this value, or null.

    • getValue

      IValue getValue()
      If the parameter is of type primitive, this method returns the value resulted from evaluating the value expression. Otherwise, this method returns null.
      Returns:
      the primitive value, or null.

    • getText

      IContentItem getText()
      If the parameter is of type text, this method returns the content item containing the text. Otherwise, this method returns null.
      Returns:
      the content item containing the text value or null.