Interface ITypedParameterValue

All Superinterfaces:
Serializable
All Known Implementing Classes:
TypedParameterValue

public interface ITypedParameterValue extends Serializable
This interface defines the contract of parameter values in a dictionary.
Since:
9.3
Author:
J. Hermus
  • Method Summary

    Modifier and Type
    Method
    Description
    This method returns the expression of this typed parameter when this is an expression parameter.
    This method returns the key of this typed parameter value.
    This method returns the name of an object this parameter is referring to when this is an reference parameter I.e a button name
    This method returns the value of this typed parameter when this is an value parameter For multivalued parameters this method will return an IListValue.
  • Method Details

    • getKey

      String getKey()
      This method returns the key of this typed parameter value. The key is typically used as a label for a value.
      Returns:
      The key, can not be null.
    • getExpression

      IExpression getExpression()
      This method returns the expression of this typed parameter when this is an expression parameter.
      Returns:
      The expression, can be null.
    • getValue

      IValue getValue()
      This method returns the value of this typed parameter when this is an value parameter For multivalued parameters this method will return an IListValue.
      Returns:
      The value, can be null.
    • getReferenceName

      String getReferenceName()
      This method returns the name of an object this parameter is referring to when this is an reference parameter I.e a button name
      Returns:
      The name of the referring object, can be null.