Package org.forgerock.am.trees.api

Enum Class Outcome

java.lang.Object

java.lang.Enum<Outcome>

org.forgerock.am.trees.api.Outcome

All Implemented Interfaces:

Serializable, Comparable<Outcome>, java.lang.constant.Constable

public enum Outcome
extends Enum<Outcome>

The possible outcomes of trees and nodes.

Since:

AM 5.5.0

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
EXCEPTION	Tree results in an exception state.
FALSE	Tree results in a negative state.
NEED_INPUT	Tree requires input from the user.
SUSPENDED	Tree authentication flow has been suspended.
TRUE	Tree results in a positive state.

Field Summary

Fields

Modifier and Type	Field	Description
static final UUID	TREE_NODE_FAILURE_ID	The ID of every tree's failure node.
static final UUID	TREE_NODE_SUCCESS_ID	The ID of every tree's success node.

Method Summary

Modifier and Type	Method	Description
static Outcome	getFromNodeID(UUID nodeId)	Return the Outcome from the uuid.
static Outcome	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Outcome[]	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

TRUE

public static final Outcome TRUE

Tree results in a positive state.

FALSE

public static final Outcome FALSE

Tree results in a negative state.

NEED_INPUT

public static final Outcome NEED_INPUT

Tree requires input from the user.

SUSPENDED

public static final Outcome SUSPENDED

Tree authentication flow has been suspended.

EXCEPTION

public static final Outcome EXCEPTION

Tree results in an exception state.

Field Details

TREE_NODE_SUCCESS_ID

public static final UUID TREE_NODE_SUCCESS_ID

The ID of every tree's success node.

TREE_NODE_FAILURE_ID

public static final UUID TREE_NODE_FAILURE_ID

The ID of every tree's failure node.

Method Details

values

public static 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 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

getFromNodeID

public static Outcome getFromNodeID(UUID nodeId)

Return the Outcome from the uuid.

Parameters:

nodeId - the uuid of the node.

Returns:

TRUE if the NODE is success, otherwise FALSE.