public final class Cause extends Enum
This class provides a mapping between the cause code registered by the system and and a detailed (translatable) message.
Modifier and Type | Field and Description |
---|---|
static Cause |
MANUAL_RECOVER_ERROR
Manual recovery.
|
static Cause |
METADATA_NOT_FOUND
Metadata not found.
|
static Cause |
NON_TERMINAL
Default terminal state.
|
static Cause |
OPERATOR_CANCEL
Request was cancelled due to operator action.
|
static Cause |
PARENT_NOT_PAUSED
Parent request did not pause during its execution.
|
static Cause |
POSTPROCESS_BIZ_ERROR
Business error occurred during post-processing.
|
static Cause |
POSTPROCESS_CANCEL
Request was cancelled during post-processing.
|
static Cause |
POSTPROCESS_ERROR
Application error occurred during post-processing.
|
static Cause |
POSTPROCESS_SYSTEM_ERROR
System error occurred during post-processing.
|
static Cause |
POSTPROCESS_WARNING
Application error occurred during post-processing.
|
static Cause |
PREPROCESS_BIZ_ERROR
Business error occurred during pre-processing.
|
static Cause |
PREPROCESS_CANCEL
Request was cancelled during pre-processing.
|
static Cause |
PREPROCESS_ERROR
Application error occurred during pre-processing.
|
static Cause |
PREPROCESS_INITIATE_CANCEL
Request was cancelled by pre-processing callout handler.
|
static Cause |
PREPROCESS_SYSTEM_ERROR
System error occurred during pre-processing.
|
static Cause |
PROCESS_BIZ_ERROR
Business error occurred during request processing.
|
static Cause |
PROCESS_CANCEL
Request processing was cancelled.
|
static Cause |
PROCESS_ERROR
Application error occurred during request processing.
|
static Cause |
PROCESS_MANUAL_RECOVER_ERROR
Job indicated there was an error during processing that requires
the request to be recovered manually
|
static Cause |
PROCESS_MANUAL_RECOVER_ERROR_FINALIZE
Job indicated there was an error during processing that requires
the request to be recovered manually
|
static Cause |
PROCESS_RECOVER
The request could not be recovered.
|
static Cause |
PROCESS_SUCCESS
Request processing was successful.
|
static Cause |
PROCESS_SYSTEM_ERROR
System error occurred during request processing.
|
static Cause |
PROCESS_TIMED_OUT
Asynchronous request has timed out.
|
static Cause |
PROCESS_UNKNOWN_STATUS
Status of the request is unknown.
|
static Cause |
PROCESS_UPDATE_BIZ_ERROR
Business error occurred during update event processing.
|
static Cause |
PROCESS_UPDATE_CANCEL
Request processing was cancelled based on update event.
|
static Cause |
PROCESS_UPDATE_ERROR
Application error occurred during update event processing.
|
static Cause |
PROCESS_UPDATE_WARNING
Application warning occurred during update event processing.
|
static Cause |
PROCESS_WARNING
Application warning occurred during request processing.
|
static Cause |
RECOVER_CANCEL
Request was cancelled during manual recovery.
|
static Cause |
RECOVER_GROUP_CANCEL
Request was cancelled during manual recovery when removing process group.
|
static Cause |
REQUEST_AUTHORIZATION_FAILED
Request execution authorzation failed.
|
static Cause |
REQUEST_EXPIRED
Request expired.
|
static Cause |
REQUEST_LOGIN_ERROR
Request submittor failed to login
|
static Cause |
SYSTEM_ERROR
System error occurred.
|
static Cause |
UNKNOWN
Unknown or invalid cause.
|
static Cause |
VALIDATION_ERROR
Validation error occurred.
|
Modifier and Type | Method and Description |
---|---|
static Cause |
fromString(String causeStr)
Converts a stringified cause into a Cause object.
|
static Cause |
getCause(int code)
Gets the Cause for the associated code.
|
int |
getCode()
Gets the code for this cause.
|
String |
getDescription()
Gets the description for this cause.
|
String |
getDescription(Locale locale)
Gets localized description for the Cause.
|
String |
toString(Locale locale)
Gets localized represention of Cause enum.
|
static Cause |
valueOf(String name) |
static Cause[] |
values() |
public static final Cause UNKNOWN
public static final Cause NON_TERMINAL
public static final Cause REQUEST_EXPIRED
public static final Cause REQUEST_LOGIN_ERROR
public static final Cause REQUEST_AUTHORIZATION_FAILED
public static final Cause SYSTEM_ERROR
public static final Cause VALIDATION_ERROR
public static final Cause METADATA_NOT_FOUND
public static final Cause OPERATOR_CANCEL
public static final Cause RECOVER_CANCEL
public static final Cause RECOVER_GROUP_CANCEL
public static final Cause PARENT_NOT_PAUSED
public static final Cause PREPROCESS_SYSTEM_ERROR
public static final Cause PREPROCESS_CANCEL
public static final Cause PREPROCESS_INITIATE_CANCEL
public static final Cause PREPROCESS_ERROR
public static final Cause PREPROCESS_BIZ_ERROR
public static final Cause PROCESS_WARNING
public static final Cause PROCESS_ERROR
public static final Cause PROCESS_CANCEL
public static final Cause PROCESS_SUCCESS
public static final Cause PROCESS_SYSTEM_ERROR
public static final Cause PROCESS_BIZ_ERROR
public static final Cause PROCESS_TIMED_OUT
public static final Cause PROCESS_UNKNOWN_STATUS
public static final Cause PROCESS_RECOVER
public static final Cause PROCESS_MANUAL_RECOVER_ERROR
public static final Cause PROCESS_MANUAL_RECOVER_ERROR_FINALIZE
public static final Cause POSTPROCESS_SYSTEM_ERROR
public static final Cause POSTPROCESS_CANCEL
public static final Cause POSTPROCESS_WARNING
public static final Cause POSTPROCESS_ERROR
public static final Cause POSTPROCESS_BIZ_ERROR
public static final Cause PROCESS_UPDATE_WARNING
public static final Cause PROCESS_UPDATE_ERROR
public static final Cause PROCESS_UPDATE_CANCEL
public static final Cause PROCESS_UPDATE_BIZ_ERROR
public static final Cause MANUAL_RECOVER_ERROR
public static Cause[] values()
public String getDescription()
public int getCode()
public static Cause getCause(int code)
code
- the code for which the Cause is being requestedpublic static Cause fromString(String causeStr)
causeStr
- causeStr
,
or Cause.Unknown
if the conversion could not be made.public String toString(Locale locale)
locale
- the Locale