Package com.axelor.workflow.spi

Enum Class ActivityEffect

java.lang.Object

java.lang.Enum<ActivityEffect>

com.axelor.workflow.spi.ActivityEffect

All Implemented Interfaces:

Serializable, Comparable<ActivityEffect>, Constable

public enum ActivityEffect
extends Enum<ActivityEffect>

What is known about an activity's outside effect when it failed: whether an email or agent call that failed may already have gone out, so an operator knows whether re-sending duplicates it. It records the effect only; whether to retry is a separate question.

UNKNOWN is the default, so an implementation that says nothing is never read as promising nothing happened.

Nested Class Summary

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

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DONE	It happened.
NONE	Nothing happened.
UNKNOWN	It may or may not have happened, and there is no way to tell from here.

Method Summary

Modifier and Type	Method	Description
String	description()	A short clause appended to the untranslated engine failure message.
static ActivityEffect	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ActivityEffect[]	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

NONE

public static final ActivityEffect NONE

Nothing happened. The activity failed before it could have any effect outside.

UNKNOWN

public static final ActivityEffect UNKNOWN

It may or may not have happened, and there is no way to tell from here.

DONE

public static final ActivityEffect DONE

It happened. Something after it failed, so the node still failed.

Method Details

values

public static ActivityEffect[] 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 ActivityEffect 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

description

public String description()

A short clause appended to the untranslated engine failure message.