Package ca.uhn.fhir.batch2.model

Enum StatusEnum

java.lang.Object

java.lang.Enum<StatusEnum>

ca.uhn.fhir.batch2.model.StatusEnum

All Implemented Interfaces:

Serializable, Comparable<StatusEnum>

public enum StatusEnum
extends Enum<StatusEnum>

Status of a Batch2 Job Instance. The initial state is QUEUED. The terminal states are COMPLETED, CANCELLED, or FAILED.

Enum Constant Summary

Enum Constants

Enum Constant	Description
CANCELLED	Task has been cancelled by the user.
COMPLETED	Task completed successfully
ERRORED	Deprecated. this is basically a synonym for IN_PROGRESS - display should use the presence of an error message on the instance to indicate that there has been a transient error.
FAILED	Task has failed and is known to be unrecoverable.
FINALIZE	For reduction steps
IN_PROGRESS	Task is current executing
QUEUED	Task is waiting to execute and should begin with no intervention required.

Method Summary

Modifier and Type	Method	Description
static Set<StatusEnum>	getEndedStatuses()	Statuses that represent a job that has ended.
static StatusEnum[]	getIncompleteStatuses()	Statuses that represent a job that has not yet completed.
Set<StatusEnum>	getNextStates()	States this state may transotion to.
static Set<StatusEnum>	getNotEndedStatuses()	Statuses that represent a job that has not ended.
Set<StatusEnum>	getPriorStates()	States that may transition to this state.
boolean	isCancellable()
boolean	isEnded()
boolean	isIncomplete()
static boolean	isLegalStateTransition(StatusEnum theOrigStatus, StatusEnum theNewStatus)
static StatusEnum	valueOf(String name)	Returns the enum constant of this type with the specified name.
static StatusEnum[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

QUEUED

public static final StatusEnum QUEUED

Task is waiting to execute and should begin with no intervention required.

IN_PROGRESS

public static final StatusEnum IN_PROGRESS

Task is current executing

FINALIZE

public static final StatusEnum FINALIZE

For reduction steps

COMPLETED

public static final StatusEnum COMPLETED

Task completed successfully

ERRORED

@Deprecated(since="6.6")
public static final StatusEnum ERRORED

Deprecated.

this is basically a synonym for IN_PROGRESS - display should use the presence of an error message on the instance to indicate that there has been a transient error.

Chunk execution resulted in an error but the error may be transient (or transient status is unknown). The job may still complete successfully.

FAILED

public static final StatusEnum FAILED

Task has failed and is known to be unrecoverable. There is no reason to believe that retrying will result in a different outcome.

CANCELLED

public static final StatusEnum CANCELLED

Task has been cancelled by the user.

Method Details

values

public static StatusEnum[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static StatusEnum valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null

getIncompleteStatuses

public static StatusEnum[] getIncompleteStatuses()

Statuses that represent a job that has not yet completed. I.e. all statuses except COMPLETED

getEndedStatuses

@Nonnull
public static Set<StatusEnum> getEndedStatuses()

Statuses that represent a job that has ended. I.e. all statuses except and #COMPLETED

getNotEndedStatuses

@Nonnull
public static Set<StatusEnum> getNotEndedStatuses()

Statuses that represent a job that has not ended. I.e. and #COMPLETED

isLegalStateTransition

public static boolean isLegalStateTransition(StatusEnum theOrigStatus,
 StatusEnum theNewStatus)

isIncomplete

public boolean isIncomplete()

isEnded

public boolean isEnded()

isCancellable

public boolean isCancellable()

getPriorStates

public Set<StatusEnum> getPriorStates()

States that may transition to this state.

getNextStates

public Set<StatusEnum> getNextStates()

States this state may transotion to.