Enum Class ProcessUpgrade.Outcome
java.lang.Object
java.lang.Enum<ProcessUpgrade.Outcome>
com.appiancorp.suiteapi.process.upgrade.ProcessUpgrade.Outcome
- All Implemented Interfaces:
Serializable
,Comparable<ProcessUpgrade.Outcome>
,Constable
- Enclosing class:
- ProcessUpgrade
Represents the outcome of an attempted upgrade of a process.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantDescriptionIndicates that the process could not be updated because its process variables were not compatible with those of the target model.Indicates that the process could not be updated because the user performing the upgrade did not have sufficient privileges.Indicates that the process id was invalid.Indicates that the process could not be updated because it was not in a state in which upgrade is allowed.Indicates that the process could not be upgraded because it is too old.Indicates that the process could not be updated because it was locked by another user.Indicates that the process did not need to be upgraded because it was already using the target process model.Indicates a successful upgrade. -
Method Summary
Modifier and TypeMethodDescriptiongetText()
Gets a short textual representation of the Outcome.boolean
Gets whether the outcome represents a successful upgrade.static ProcessUpgrade.Outcome
Returns the enum constant of this class with the specified name.static ProcessUpgrade.Outcome[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
SUCCESS
Indicates a successful upgrade. -
SAME_MODEL
Indicates that the process did not need to be upgraded because it was already using the target process model. -
INVALID_PROCESS
Indicates that the process id was invalid. -
INSUFFICIENT_PRIVILEGES
Indicates that the process could not be updated because the user performing the upgrade did not have sufficient privileges. -
INVALID_STATE
Indicates that the process could not be updated because it was not in a state in which upgrade is allowed. -
PROCESS_LOCKED
Indicates that the process could not be updated because it was locked by another user. -
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
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 Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified nameNullPointerException
- 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
Gets a short textual representation of the Outcome.- Returns:
- text representing the Outcome
-