Package com.mendix.core.actionmanagement

Class EventActionInfo<T>

  • public class EventActionInfo<T>
extends java.lang.Object
    Represents an event action.

    • Constructor Summary

      Constructors 
      Constructor Description
      EventActionInfo​(java.lang.String classOrActionName, boolean raiseExceptionOnFalse)
      Creates an event action with the specified name.
      EventActionInfo​(java.util.function.Consumer<IMendixObject> consumer)
      Creates an event action with the specified Java function.
      EventActionInfo​(java.util.function.Consumer<IMendixObject> consumer, boolean raiseExceptionOnFalse)
      Creates an event action with the specified Java function.
      EventActionInfo​(java.util.function.Consumer<T> consumer, java.lang.Class<T> returnType)
      Creates an event action with the specified Java action.
      EventActionInfo​(java.util.function.Consumer<T> consumer, java.lang.Class<T> returnType, boolean raiseExceptionOnFalse)
      Creates an event action with the specified Java action.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.function.Consumer<IMendixObject> function()
      Returns the Java function for this event action.
      java.lang.Class<T> getReturnType()
      Returns the Java type of the result value.
      java.lang.Boolean representsFunction()
      Returns whether the event action is a Java function or not.

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • actionName

        public final java.lang.String actionName

      • raiseExceptionOnFalse

        public final boolean raiseExceptionOnFalse

    • Constructor Detail

      • EventActionInfo

        public EventActionInfo​(java.lang.String classOrActionName,
                       boolean raiseExceptionOnFalse)
        Creates an event action with the specified name.
        Parameters:
        classOrActionName - the name of the custom Java action or microflow
        raiseExceptionOnFalse - whether to throw an exception if the action returns false

      • EventActionInfo

        public EventActionInfo​(java.util.function.Consumer<T> consumer,
                       java.lang.Class<T> returnType)
        Creates an event action with the specified Java action. The action will not raise an exception when its result is false.
        Parameters:
        consumer - the Java function to execute
        returnType - the Java type of the result value

      • EventActionInfo

        public EventActionInfo​(java.util.function.Consumer<T> consumer,
                       java.lang.Class<T> returnType,
                       boolean raiseExceptionOnFalse)
        Creates an event action with the specified Java action.
        Parameters:
        consumer - the Java function to execute
        returnType - the Java type of the result value
        raiseExceptionOnFalse - whether to throw an exception if the action returns false

      • EventActionInfo

        public EventActionInfo​(java.util.function.Consumer<IMendixObject> consumer)
        Creates an event action with the specified Java function. The action will not raise an exception when its result is false.
        Parameters:
        consumer - the Java function to execute

      • EventActionInfo

        public EventActionInfo​(java.util.function.Consumer<IMendixObject> consumer,
                       boolean raiseExceptionOnFalse)
        Creates an event action with the specified Java function.
        Parameters:
        consumer - the Java function to execute
        raiseExceptionOnFalse - whether to throw an exception if the action returns false

    • Method Detail

      • representsFunction

        public java.lang.Boolean representsFunction()
        Returns whether the event action is a Java function or not.
        Returns:
        true if the action is a function; false otherwise

      • function

        public java.util.function.Consumer<IMendixObject> function()
        Returns the Java function for this event action.
        Returns:
        the function if defined; null otherwise

      • getReturnType

        public java.lang.Class<T> getReturnType()
        Returns the Java type of the result value.
        Returns:
        the Java type of the result value