Package com.aquima.interactions.expressions.functions

Interface IArgumentType

All Superinterfaces:
Serializable
All Known Implementing Classes:
FunctionArgument
public interface IArgumentType extends Serializable
Interface that defines the methods for an argument type declaration. This interface is used in function definitions to declare the type of arguments that are required for the function.
Since:
5.0
Author:
O. Kerpershoek, F. van der Meer

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getName()
    This method returns the name of the argument.
    DataType
    getType()
    This method returns the data type of the argument.
    boolean
    isMultivalue()
    This method returns a boolean indicating if the argument is a list value.
    boolean
    isOptional()
    This method returns a boolean indicating if the argument is optional.

  • Method Details

    • getType

      DataType getType()
      This method returns the data type of the argument.
      Returns:
      the data type of the argument.

    • getName

      String getName()
      This method returns the name of the argument. The current implementation does not (yet) bind the arguments by name, hence this parameter is optional.
      Returns:
      The name of the parameter.

    • isMultivalue

      boolean isMultivalue()
      This method returns a boolean indicating if the argument is a list value.
      Returns:
      boolean indicating if the argument is a list value.

    • isOptional

      boolean isOptional()
      This method returns a boolean indicating if the argument is optional. An optional argument may be omitted when invoking the function. Optional arguments may only be followed by other optional arguments.
      Returns:
      Boolean indicating if the argument is optional.