flux
Enum SubState

java.lang.Object
  java.lang.Enum<SubState>
      flux.SubState

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SubState>

public enum SubState
extends java.lang.Enum<SubState>

Represents valid sub-states in which job execution flow contexts can exist. The state of a job execution flow context is the combination of its super-state and its sub-state. The sub-state indicates whether the job execution flow context is waiting for a trigger to fire, currently firing, paused, failed after attempting to recover from an error in a default flow chart error handler, etc.

Author:

Copyright 2014 Flux Corporation. All rights reserved.

Enum Constant Summary

AGENT_FINISHED
An execution flow context in the AGENT_FINISHED sub-state contains a process action that has finished executing on an agent.

ANY
Matches any sub-state.

FAILED
An execution flow context in the FAILED sub-state has failed to recover from an error and is waiting for some kind of external intervention.

FINISHED
An execution flow context in the FINISHED sub-state is done executing and is ready to be deleted by the Flux engine.

FIRING
An execution flow context in the FIRING sub-state is executing.

JOINING
An execution flow context in the JOINING sub-state is waiting for other inbound execution flow contexts at a join point.

PAUSED
An execution flow context in the PAUSED sub-state is temporarily prevented from executing.

TRIGGERING
An execution flow context in the TRIGGERING sub-state is waiting for an event to occur.

WAITING
An execution flow context in the WAITING sub-state is eligible for execution at a specific time in the future.

WAITING_FOR_AGENT_TO_FINISH
An execution flow context in the WAITING_FOR_AGENT_TO_FINISH sub-state is waiting for a process action on an agent to finish executing.

WAITING_FOR_FREE_AGENT
An execution flow context in the WAITING_FOR_FREE_AGENT sub-state cannot locate an available agent on which to run its process action and is waiting for a free agent to become available.

Method Summary

static SubState	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static SubState[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ANY

public static final SubState ANY

Matches any sub-state. Used for querying sub-states where it does not matter what the actual sub-state is.

AGENT_FINISHED

public static final SubState AGENT_FINISHED

An execution flow context in the AGENT_FINISHED sub-state contains a process action that has finished executing on an agent. The execution flow context in the AGENT_FINISHED sub-state is ready for the Flux engine to resume its execution.

FAILED

public static final SubState FAILED

An execution flow context in the FAILED sub-state has failed to recover from an error and is waiting for some kind of external intervention. The FAILED sub-state is legal only if the super-state is ERROR. An execution flow context in the FAILED sub-state is temporarily prevented from executing.

FINISHED

public static final SubState FINISHED

An execution flow context in the FINISHED sub-state is done executing and is ready to be deleted by the Flux engine.

FIRING

public static final SubState FIRING

An execution flow context in the FIRING sub-state is executing.

JOINING

public static final SubState JOINING

An execution flow context in the JOINING sub-state is waiting for other inbound execution flow contexts at a join point.

PAUSED

public static final SubState PAUSED

An execution flow context in the PAUSED sub-state is temporarily prevented from executing.

TRIGGERING

public static final SubState TRIGGERING

An execution flow context in the TRIGGERING sub-state is waiting for an event to occur. For example, manual triggers exist in the TRIGGERING sub-state as they wait for an event to occur or to be expedited.

The following information is of interest to software developers who create custom triggers. Any trigger that returns null from the flux.dev.TriggerDev.getNextPollingDate() method is placed into the TRIGGERING sub-state.

WAITING

public static final SubState WAITING

An execution flow context in the WAITING sub-state is eligible for execution at a specific time in the future. For example, active timer triggers exist in the WAITING sub-state as they wait for their scheduled firing time to arrive.

WAITING_FOR_AGENT_TO_FINISH

public static final SubState WAITING_FOR_AGENT_TO_FINISH

An execution flow context in the WAITING_FOR_AGENT_TO_FINISH sub-state is waiting for a process action on an agent to finish executing.

WAITING_FOR_FREE_AGENT

public static final SubState WAITING_FOR_FREE_AGENT

An execution flow context in the WAITING_FOR_FREE_AGENT sub-state cannot locate an available agent on which to run its process action and is waiting for a free agent to become available. Although there may be many agents registered with a cluster of Flux engines, they may all be busy running processes. Sometimes it is necessary for an execution flow context to wait for a free agent to become available.

Method Detail

values

public static SubState[] 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 (SubState c : SubState.values())
    System.out.println(c);

Returns:

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

valueOf

public static SubState valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null