com.mulesoft.mule.runtime.module.batch.api

Enum BatchJobInstanceStatus

java.lang.Object

java.lang.Enum<BatchJobInstanceStatus>

com.mulesoft.mule.runtime.module.batch.api.BatchJobInstanceStatus

All Implemented Interfaces:

Serializable, Comparable<BatchJobInstanceStatus>

public enum BatchJobInstanceStatus
extends Enum<BatchJobInstanceStatus>

Lists the possible states of a BatchJobInstance

Since:

3.5.0

Enum Constant Summary

Enum Constants

Enum Constant and Description
CANCELLED The processed has been stopped and cannot be resumed.
EXECUTING It means that records are flowing through the steps and are being processed
FAILED_INPUT The input phase failed and execution cannot continue
FAILED_LOADING The loading phase failed and execution cannot continue
FAILED_ON_COMPLETE Process records phase completed but an exception was found in the on-complete section
FAILED_PROCESS_RECORDS The process records phase failed
LOADING This means that the input phase is being processed (if present) and that the persistent queues are being loaded
STOPPED The process has been stopped and can be resumed.
SUCCESSFUL The job was successfully executed form end to end

Method Summary

Modifier and Type	Method and Description
boolean	isExecutable() Whether this states denotes that the BatchJobInstance is currently executable.
boolean	isFailure() Whether or not a status is irrevocably associated with an error condition.
static BatchJobInstanceStatus	valueOf(String name) Returns the enum constant of this type with the specified name.
static BatchJobInstanceStatus[]	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 Detail

LOADING

public static final BatchJobInstanceStatus LOADING

This means that the input phase is being processed (if present) and that the persistent queues are being loaded

FAILED_LOADING

public static final BatchJobInstanceStatus FAILED_LOADING

The loading phase failed and execution cannot continue

EXECUTING

public static final BatchJobInstanceStatus EXECUTING

It means that records are flowing through the steps and are being processed

STOPPED

public static final BatchJobInstanceStatus STOPPED

The process has been stopped and can be resumed.

FAILED_INPUT

public static final BatchJobInstanceStatus FAILED_INPUT

The input phase failed and execution cannot continue

FAILED_ON_COMPLETE

public static final BatchJobInstanceStatus FAILED_ON_COMPLETE

Process records phase completed but an exception was found in the on-complete section

FAILED_PROCESS_RECORDS

public static final BatchJobInstanceStatus FAILED_PROCESS_RECORDS

The process records phase failed

SUCCESSFUL

public static final BatchJobInstanceStatus SUCCESSFUL

The job was successfully executed form end to end

CANCELLED

public static final BatchJobInstanceStatus CANCELLED

The processed has been stopped and cannot be resumed.

Method Detail

values

public static BatchJobInstanceStatus[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (BatchJobInstanceStatus c : BatchJobInstanceStatus.values())
    System.out.println(c);

Returns:

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

valueOf

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

isFailure

public boolean isFailure()

Whether or not a status is irrevocably associated with an error condition. This does not mean that if the return value is false then the job instance doesn't have failures. For example, imagine a job that allows up to 100 record failures. If ten records fail, then the processing is still going because the upper bound hasn't been reached. However, the EXECUTING status will return false but the BatchJobInstance has failures nevertheless

isExecutable

public boolean isExecutable()

Whether this states denotes that the BatchJobInstance is currently executable.

Notice that there's a difference between being executable and actually being executed

Returns:

true if the owning BatchJobInstance is executable. false otherwise