Package io.jmix.bpmflowui.model

Enum Class HistoryLevel

java.lang.Object

java.lang.Enum<HistoryLevel>

io.jmix.bpmflowui.model.HistoryLevel

All Implemented Interfaces:

EnumClass<String>, Serializable, Comparable<HistoryLevel>, Constable

public enum HistoryLevel
extends Enum<HistoryLevel>
implements EnumClass<String>

The Flowable history level configured for a single process definition, serialized as the body of a <flowable:historyLevel> extension element on <process>.

The absence of a level (the modeler's "Default" choice) is represented by a null value rather than a constant: no extension element is written and the engine falls back to the global flowable.history-level property.

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
ACTIVITY	Process instances, tasks and every executed activity (node), but not variable values.
AUDIT	Everything ACTIVITY keeps plus variable values and submitted form properties, so all user interaction is traceable.
FULL	The most verbose level: everything AUDIT keeps plus the history of each variable update.
INSTANCE	Only the historic process instances (their start and end); no task, activity or variable detail.
NONE	No history is archived at all.
TASK	Historic process instances and historic tasks; no activity or variable detail.

Method Summary

Modifier and Type	Method	Description
static HistoryLevel	fromId(String id)
String	getId()
static HistoryLevel	valueOf(String name)	Returns the enum constant of this class with the specified name.
static HistoryLevel[]	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 HistoryLevel NONE

No history is archived at all.

INSTANCE

public static final HistoryLevel INSTANCE

Only the historic process instances (their start and end); no task, activity or variable detail.

TASK

public static final HistoryLevel TASK

Historic process instances and historic tasks; no activity or variable detail.

ACTIVITY

public static final HistoryLevel ACTIVITY

Process instances, tasks and every executed activity (node), but not variable values.

AUDIT

public static final HistoryLevel AUDIT

Everything ACTIVITY keeps plus variable values and submitted form properties, so all user interaction is traceable. This is the Flowable engine default.

FULL

public static final HistoryLevel FULL

The most verbose level: everything AUDIT keeps plus the history of each variable update.

Method Details

values

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

getId

public String getId()

Specified by:

getId in interface EnumClass<String>

fromId

public static HistoryLevel fromId(String id)