Interface VariableType

    • Method Detail

      • getTypeName

        java.lang.String getTypeName()
        name of variable type (limited to 100 characters length)
      • isCachable

        boolean isCachable()

        Indicates if this variable type supports caching.

        If caching is supported, the result of getValue(ValueFields) is saved for the duration of the session and used for subsequent reads of the variable's value.

        If caching is not supported, all reads of a variable's value require a fresh call to getValue(ValueFields).

        Returns:
        whether variables of this type are cacheable.
      • isAbleToStore

        boolean isAbleToStore​(java.lang.Object value)
        Returns:
        whether this variable type can store the specified value.
      • setValue

        void setValue​(java.lang.Object value,
                      ValueFields valueFields)
        Stores the specified value in the supplied ValueFields.
      • getValue

        java.lang.Object getValue​(ValueFields valueFields)
        Returns:
        the value of a variable based on the specified ValueFields.