Package org.apache.juneau.console.views

Enum Class ActionResult.Outcome

java.lang.Object

java.lang.Enum<ActionResult.Outcome>

org.apache.juneau.console.views.ActionResult.Outcome

All Implemented Interfaces:

Serializable, Comparable<ActionResult.Outcome>, Constable

Enclosing class:

ActionResult

public static enum ActionResult.Outcome
extends Enum<ActionResult.Outcome>

The outcome discriminator a row-action submit reports.

Each constant carries the lowercase wire token emitted for the outcome field. The four synchronous outcomes (SUCCESS, FAILURE, REFUSAL, UNKNOWN) are what a synchronous write can emit; CANCELLED and CANCELLED_AFTER_EFFECT are reserved for a future async variant and are frozen here so that contract does not force a second result-contract bump.

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
CANCELLED	Reserved for a future async variant: the job was cancelled before any effect.
CANCELLED_AFTER_EFFECT	Reserved for a future async variant: the job was cancelled after a partial/uncertain effect.
FAILURE	The write was attempted and failed.
REFUSAL	The write was refused; ActionResult.refusalCode carries the named reason.
SUCCESS	The write completed and ActionResult.row carries the authoritative row read back.
UNKNOWN	The write's outcome is genuinely unknown (e.g. a crash mid-write) — an honest, non-optimistic state.

Method Summary

Modifier and Type	Method	Description
static ActionResult.Outcome	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ActionResult.Outcome[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.
String	wire()	Returns the lowercase wire token for this outcome.

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

SUCCESS

public static final ActionResult.Outcome SUCCESS

The write completed and ActionResult.row carries the authoritative row read back.

FAILURE

public static final ActionResult.Outcome FAILURE

The write was attempted and failed.

REFUSAL

public static final ActionResult.Outcome REFUSAL

The write was refused; ActionResult.refusalCode carries the named reason.

UNKNOWN

public static final ActionResult.Outcome UNKNOWN

The write's outcome is genuinely unknown (e.g. a crash mid-write) — an honest, non-optimistic state.

CANCELLED

public static final ActionResult.Outcome CANCELLED

Reserved for a future async variant: the job was cancelled before any effect.

CANCELLED_AFTER_EFFECT

public static final ActionResult.Outcome CANCELLED_AFTER_EFFECT

Reserved for a future async variant: the job was cancelled after a partial/uncertain effect.

Method Details

values

public static ActionResult.Outcome[] 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 ActionResult.Outcome 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

wire

public String wire()

Returns the lowercase wire token for this outcome.

Returns:

The wire token (e.g. "success").