com.appiancorp.exceptions

Class AppianErrorCode

java.lang.Object

com.appiancorp.exceptions.AppianErrorCode

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

ErrorCode, ValidationCode

public abstract class AppianErrorCode
extends java.lang.Object
implements java.io.Serializable

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AppianErrorCode.InvalidErrorCode

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AppianErrorCode()
protected	AppianErrorCode(java.lang.String code)
protected	AppianErrorCode(java.lang.String code, boolean hasTitle)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object other)
int	getCategory()
int	getDetail()
java.lang.String	getMessage(AppianErrorCodeFormatter callback, java.lang.Object... arguments)
java.lang.String	getMessageWithCode(AppianErrorCodeFormatter callback, java.lang.Object... arguments)
int	getNamespace()
java.lang.String	getTitle(AppianErrorCodeTitleFormatter callback, java.lang.Object... arguments)
int	hashCode()
boolean	hasTitle() Indicates whether or not the given ErrorCode has a title corresponding to its message.
static AppianErrorCode	toErrorCode(java.lang.String code) Returns the error code.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AppianErrorCode

protected AppianErrorCode()

AppianErrorCode

protected AppianErrorCode(java.lang.String code)
                   throws AppianErrorCode.InvalidErrorCode

Throws:

AppianErrorCode.InvalidErrorCode

AppianErrorCode

protected AppianErrorCode(java.lang.String code,
                          boolean hasTitle)
                   throws AppianErrorCode.InvalidErrorCode

Throws:

AppianErrorCode.InvalidErrorCode

Method Detail

hasTitle

public final boolean hasTitle()

Indicates whether or not the given ErrorCode has a title corresponding to its message.

Returns:

true if the error code has a title

toErrorCode

public static AppianErrorCode toErrorCode(java.lang.String code)

Returns the error code. Will return null if the error code is not found. Codes should generally be referenced explicitly from a static member of ErrorCode. This is used currently in GWT and PMM Connected Environments so the server can send down the string code of an ErrorCode and an instance can be returned from the string code. See https://source.appian.com/cru/CR-AE-1752#CFR-23290

Parameters:

code - The string representation of an error code, example APNX-1-0000-000

Returns:

An AppianErrorCode

getNamespace

public int getNamespace()

getCategory

public int getCategory()

getDetail

public int getDetail()

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getMessage

public java.lang.String getMessage(AppianErrorCodeFormatter callback,
                                   java.lang.Object... arguments)

getTitle

public java.lang.String getTitle(AppianErrorCodeTitleFormatter callback,
                                 java.lang.Object... arguments)

getMessageWithCode

public java.lang.String getMessageWithCode(AppianErrorCodeFormatter callback,
                                           java.lang.Object... arguments)