Package com.aquima.interactions.expressions.functions.date

Class Today

java.lang.Object
com.aquima.interactions.expressions.functions.date.Today
All Implemented Interfaces:
IFunction, Serializable
public class Today extends Object implements IFunction
This function may be used to request the current time or date. By using this function, the current date or time is considered a constant, and will thus not influence the truth maintenance system.
Since:
7.1
Author:
O. Kerpershoek
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    Today(boolean includeTime)
    Constructs the function with the required arguments.

  • Method Summary

    Modifier and Type
    Method
    Description
    Type
    determineResultType(ISemanticNode... arguments)
    This method is used to determine the result type of the function using the type information of the parameters that will be passed to the function.
    IValue
    evaluate(IArgumentList arguments)
    This method should execute the function using the supplied arguments.
    IArgumentType[]
    getArguments()
    This method returns an array containing the definitions of the arguments the function expects.
    String
    getName()
    This method returns the name of the function.
    boolean
    isDeprecated()
    This method returns a boolean indicating that the function is deprecated and should no longer be used.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • Today

      public Today(boolean includeTime)
      Constructs the function with the required arguments.
      Parameters:
      includeTime - Boolean indicating if the time should be included in the resulting date.

  • Method Details

    • evaluate

      public IValue evaluate(IArgumentList arguments)
      Description copied from interface: IFunction
      This method should execute the function using the supplied arguments.
      Specified by:
      evaluate in interface IFunction
      Parameters:
      arguments - The arguments for the function.
      Returns:
      The result of the function.

    • getName

      public String getName()
      Description copied from interface: IFunction
      This method returns the name of the function.
      Specified by:
      getName in interface IFunction
      Returns:
      the name of the function.

    • isDeprecated

      public boolean isDeprecated()
      Description copied from interface: IFunction
      This method returns a boolean indicating that the function is deprecated and should no longer be used. Functions that are not deprecated should return the value false.
      Specified by:
      isDeprecated in interface IFunction
      Returns:
      A message indicating that the function is deprecated.

    • getArguments

      public IArgumentType[] getArguments()
      Description copied from interface: IFunction
      This method returns an array containing the definitions of the arguments the function expects. When the function does not accept any arguments at all, an empty array should be returned.
      Specified by:
      getArguments in interface IFunction
      Returns:
      Array containing the definitions of the parameters.

    • determineResultType

      public Type determineResultType(ISemanticNode... arguments)
      Description copied from interface: IFunction
      This method is used to determine the result type of the function using the type information of the parameters that will be passed to the function.
      Specified by:
      determineResultType in interface IFunction
      Parameters:
      arguments - The type information of the parameters.
      Returns:
      The result type of the function.