mn.foreman.api.endpoints.actions

Enum StatusRunning

java.lang.Object

java.lang.Enum<StatusRunning>

mn.foreman.api.endpoints.actions.StatusRunning

All Implemented Interfaces:

Serializable, Comparable<StatusRunning>

public enum StatusRunning
extends Enum<StatusRunning>

The action statuses.

Enum Constant Summary

Enum Constants

Enum Constant and Description
COMPLETE Action completed successfully.
FAILED Action failed.
IN_PROGRESS Action is currently running.
PENDING Action is pending.

Method Summary

Modifier and Type	Method and Description
boolean	isDone() Returns whether or not the action is done.
boolean	isSuccess() Returns whether or not the action is done.
static StatusRunning	valueOf(String name) Returns the enum constant of this type with the specified name.
static StatusRunning[]	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

PENDING

public static final StatusRunning PENDING

Action is pending.

IN_PROGRESS

public static final StatusRunning IN_PROGRESS

Action is currently running.

COMPLETE

public static final StatusRunning COMPLETE

Action completed successfully.

FAILED

public static final StatusRunning FAILED

Action failed.

Method Detail

values

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

Returns:

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

valueOf

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

isDone

public boolean isDone()

Returns whether or not the action is done.

Returns:

Whether or not the action is done.

isSuccess

public boolean isSuccess()

Returns whether or not the action is done.

Returns:

Whether or not the action is done.