Package com.axelor.meta.schema.workflows

Enum Class EventKind

java.lang.Object

java.lang.Enum<EventKind>

com.axelor.meta.schema.workflows.EventKind

All Implemented Interfaces:

Serializable, Comparable<EventKind>, Constable

public enum EventKind
extends Enum<EventKind>

What a <wait> or <boundary> is triggered by. A boundary accepts every kind a wait does and more; the schema and the validator narrow each element's set.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	EventKind.Family	What a trigger asks of the author, and what the runtime does with it.

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CONDITION
ERROR
MESSAGE
SIGNAL
TIMER

Method Summary

Modifier and Type	Method	Description
EventKind.Family	family()	This trigger's family: a switch with no default, so a new kind cannot belong to none.
boolean	parks()	Whether a run can park waiting for this; a <wait> takes only these kinds.
String	token()	The token an author writes, for naming a kind back to them in a violation.
static EventKind	valueOf(String name)	Returns the enum constant of this class with the specified name.
static EventKind[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

TIMER

public static final EventKind TIMER

CONDITION

public static final EventKind CONDITION

ERROR

public static final EventKind ERROR

MESSAGE

public static final EventKind MESSAGE

SIGNAL

public static final EventKind SIGNAL

Method Details

values

public static EventKind[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static EventKind valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

family

public EventKind.Family family()

This trigger's family: a switch with no default, so a new kind cannot belong to none.

token

public String token()

The token an author writes, for naming a kind back to them in a violation.

parks

public boolean parks()

Whether a run can park waiting for this; a <wait> takes only these kinds.