Enum Class EffectStatus

java.lang.Object

java.lang.Enum<EffectStatus>

com.kingsrook.qqq.backend.core.jobs.effects.EffectStatus

All Implemented Interfaces:

PossibleValueEnum<String>, Serializable, Comparable<EffectStatus>, Constable

public enum EffectStatus
extends Enum<EffectStatus>
implements PossibleValueEnum<String>

Status of one outbox effect (jobs_effect.status). PENDING (due for delivery) -> SENDING (leased by a dispatcher) -> SENT, FAILED (definitely not delivered) or UNKNOWN (may have been delivered; it is reconciled, or queued for review with needsReview).

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
FAILED
PENDING
SENDING
SENT
UNKNOWN

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME

Method Summary

Modifier and Type	Method	Description
String	getPossibleValueId()
String	getPossibleValueLabel()
boolean	isOutstanding()	Whether the effect still holds its job open (not SENT or FAILED).
static EffectStatus	valueOf(String name)	Returns the enum constant of this class with the specified name.
static EffectStatus[]	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

PENDING

public static final EffectStatus PENDING

SENDING

public static final EffectStatus SENDING

SENT

public static final EffectStatus SENT

FAILED

public static final EffectStatus FAILED

UNKNOWN

public static final EffectStatus UNKNOWN

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

Method Details

values

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

getPossibleValueId

public String getPossibleValueId()

Specified by:

getPossibleValueId in interface PossibleValueEnum<String>

getPossibleValueLabel

public String getPossibleValueLabel()

Specified by:

getPossibleValueLabel in interface PossibleValueEnum<String>

isOutstanding

public boolean isOutstanding()

Whether the effect still holds its job open (not SENT or FAILED).