com.appiancorp.suiteapi.process.upgrade

Enum ProcessUpgrade.Outcome

java.lang.Object

java.lang.Enum<ProcessUpgrade.Outcome>

com.appiancorp.suiteapi.process.upgrade.ProcessUpgrade.Outcome

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ProcessUpgrade.Outcome>

Enclosing class:

ProcessUpgrade

public static enum ProcessUpgrade.Outcome
extends java.lang.Enum<ProcessUpgrade.Outcome>

Represents the outcome of an attempted upgrade of a process.

Enum Constant Summary

Enum Constants

Enum Constant and Description
INCOMPATIBLE_PVS Indicates that the process could not be updated because its process variables were not compatible with those of the target model.
INSUFFICIENT_PRIVILEGES Indicates that the process could not be updated because the user performing the upgrade did not have sufficient privileges.
INVALID_PROCESS Indicates that the process id was invalid.
INVALID_STATE Indicates that the process could not be updated because it was not in a state in which upgrade is allowed.
MODEL_TOO_OLD Indicates that the process could not be upgraded because it is too old.
PROCESS_LOCKED Indicates that the process could not be updated because it was locked by another user.
SAME_MODEL Indicates that the process did not need to be upgraded because it was already using the target process model.
SUCCESS Indicates a successful upgrade.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getText() Gets a short textual representation of the Outcome.
boolean	isSuccessfulUpgrade() Gets whether the outcome represents a successful upgrade.
static ProcessUpgrade.Outcome	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ProcessUpgrade.Outcome[]	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

SUCCESS

public static final ProcessUpgrade.Outcome SUCCESS

Indicates a successful upgrade.

SAME_MODEL

public static final ProcessUpgrade.Outcome SAME_MODEL

Indicates that the process did not need to be upgraded because it was already using the target process model.

INVALID_PROCESS

public static final ProcessUpgrade.Outcome INVALID_PROCESS

Indicates that the process id was invalid.

INSUFFICIENT_PRIVILEGES

public static final ProcessUpgrade.Outcome INSUFFICIENT_PRIVILEGES

Indicates that the process could not be updated because the user performing the upgrade did not have sufficient privileges.

INVALID_STATE

public static final ProcessUpgrade.Outcome INVALID_STATE

Indicates that the process could not be updated because it was not in a state in which upgrade is allowed.

PROCESS_LOCKED

public static final ProcessUpgrade.Outcome PROCESS_LOCKED

Indicates that the process could not be updated because it was locked by another user.

INCOMPATIBLE_PVS

public static final ProcessUpgrade.Outcome INCOMPATIBLE_PVS

Indicates that the process could not be updated because its process variables were not compatible with those of the target model.

MODEL_TOO_OLD

public static final ProcessUpgrade.Outcome MODEL_TOO_OLD

Indicates that the process could not be upgraded because it is too old. Only processes started from process model versions created on Appian 5.6 or later can be upgraded in bulk.

Method Detail

values

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

Returns:

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

valueOf

public static ProcessUpgrade.Outcome 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

isSuccessfulUpgrade

public boolean isSuccessfulUpgrade()

Gets whether the outcome represents a successful upgrade.

Returns:

true if the outcome is either SUCCESS or SAME_MODEL, false otherwise

getText

public java.lang.String getText()

Gets a short textual representation of the Outcome.

Returns:

text representing the Outcome