Package com.mendix.core.actionmanagement

Class EventActionInfo

java.lang.Object

com.mendix.core.actionmanagement.EventActionInfo

public class EventActionInfo
extends Object

Represents an event action.

Field Summary

Fields

Modifier and Type	Field	Description
final String	actionName
final boolean	raiseExceptionOnFalse

Constructor Summary

Constructors

Constructor	Description
EventActionInfo(String classOrActionName, boolean raiseExceptionOnFalse)	Creates an event action with the specified name.
EventActionInfo(Consumer<IMendixObject> consumer)	Creates an event action with the specified Java function.
EventActionInfo(Consumer<IMendixObject> consumer, boolean raiseExceptionOnFalse)	Creates an event action with the specified Java function.
EventActionInfo(Consumer<IMendixObject> consumer, Class<IMendixObject> returnType)	Deprecated. since 11.0.
EventActionInfo(Consumer<IMendixObject> consumer, Class<IMendixObject> returnType, boolean raiseExceptionOnFalse)	Deprecated. since 11.0.

Method Summary

Modifier and Type	Method	Description
Consumer<IMendixObject>	function()	Returns the Java function for this event action.
Class<IMendixObject>	getReturnType()	Deprecated. since 11.0.
Boolean	representsFunction()	Deprecated. since 11.0.

Methods inherited from class java.lang.Object

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

Field Details

actionName

public final String actionName

raiseExceptionOnFalse

public final boolean raiseExceptionOnFalse

Constructor Details

EventActionInfo

public EventActionInfo(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

@Deprecated
public EventActionInfo(Consumer<IMendixObject> consumer,
 Class<IMendixObject> returnType)

Deprecated.

since 11.0. Use EventActionInfo(Consumer).

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

@Deprecated
public EventActionInfo(Consumer<IMendixObject> consumer,
 Class<IMendixObject> returnType,
 boolean raiseExceptionOnFalse)

Deprecated.

since 11.0. Use EventActionInfo(String, boolean).

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(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(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 Details

representsFunction

@Deprecated
public Boolean representsFunction()

Deprecated.

since 11.0. Use function() to check whether this `EventActionInfo` represents a function.

Returns whether the event action is a Java function or not.

Returns:

true if the action is a function; false otherwise

function

public Consumer<IMendixObject> function()

Returns the Java function for this event action.

Returns:

the function if defined; null otherwise

getReturnType

@Deprecated
public Class<IMendixObject> getReturnType()

Deprecated.

since 11.0. There is no replacement as this return type is not used.

Returns the Java type of the result value.

Returns:

the Java type of the result value