Interface FunctionDescription

    • Method Detail

      • getCanonicalName

        java.lang.String getCanonicalName()
      • getDisplayName

        java.lang.String getDisplayName​(java.util.Locale locale)
      • getDescription

        java.lang.String getDescription​(java.util.Locale locale)
      • isVolatile

        boolean isVolatile()
      • getValueType

        Type getValueType()
      • getParameterCount

        int getParameterCount()
      • isInfiniteParameterCount

        boolean isInfiniteParameterCount()
      • getParameterType

        Type getParameterType​(int position)
        Returns the parameter type at the given position using the function metadata. The first parameter is at the position 0;
        Parameters:
        position - The parameter index.
        Returns:
        The parameter type.
      • getParameterDisplayName

        java.lang.String getParameterDisplayName​(int position,
                                                 java.util.Locale locale)
      • getParameterDescription

        java.lang.String getParameterDescription​(int position,
                                                 java.util.Locale locale)
      • isParameterMandatory

        boolean isParameterMandatory​(int position)
        Defines, whether the parameter at the given position is mandatory. A mandatory parameter must be filled in, while optional parameters need not to be filled in.
        Returns:
      • getDefaultValue

        java.lang.Object getDefaultValue​(int position)
        Returns the default value for an optional parameter. If the value returned here is null, then this either means, that the parameter is mandatory or that the default value is computed by the expression itself.
        Parameters:
        position -
        Returns: