Enum Class JobStatus

java.lang.Object

java.lang.Enum<JobStatus>

com.kingsrook.qqq.backend.core.jobs.model.JobStatus

All Implemented Interfaces:

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

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

Status of a durable job (jobs_job.status).

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
AWAITING_CONFIRMATION
CANCELLED
CANCELLING
COMPLETED
COMPLETED_WITH_ERRORS
FAILED
NEEDS_REVIEW
PAUSED
PAUSING
PLANNING
QUEUED
RUNNING

Field Summary

Fields

Modifier and Type	Field	Description
static final String	NAME

Method Summary

Modifier and Type	Method	Description
String	getPossibleValueId()
String	getPossibleValueLabel()
boolean	isClaimable()	True for statuses in which workers may claim the job's chunks.
boolean	isTerminal()	True for statuses a job never leaves on its own.
static JobStatus	valueOf(String name)	Returns the enum constant of this class with the specified name.
static JobStatus[]	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

AWAITING_CONFIRMATION

public static final JobStatus AWAITING_CONFIRMATION

QUEUED

public static final JobStatus QUEUED

PLANNING

public static final JobStatus PLANNING

RUNNING

public static final JobStatus RUNNING

PAUSING

public static final JobStatus PAUSING

PAUSED

public static final JobStatus PAUSED

CANCELLING

public static final JobStatus CANCELLING

CANCELLED

public static final JobStatus CANCELLED

COMPLETED

public static final JobStatus COMPLETED

COMPLETED_WITH_ERRORS

public static final JobStatus COMPLETED_WITH_ERRORS

FAILED

public static final JobStatus FAILED

NEEDS_REVIEW

public static final JobStatus NEEDS_REVIEW

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

Method Details

values

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

isTerminal

public boolean isTerminal()

True for statuses a job never leaves on its own.

isClaimable

public boolean isClaimable()

True for statuses in which workers may claim the job's chunks.