org.odpi.openmetadata.userinterface.uichassis.springboot.api.rex

Enum RexErrorCode

java.lang.Object

java.lang.Enum<RexErrorCode>

org.odpi.openmetadata.userinterface.uichassis.springboot.api.rex.RexErrorCode

All Implemented Interfaces:

Serializable, Comparable<RexErrorCode>, ExceptionMessageSet

public enum RexErrorCode
extends Enum<RexErrorCode>
implements ExceptionMessageSet

The RexErrorCode is used to define first failure data capture (FFDC) for errors that occur within REX. It is used in conjunction with all exceptions, both Checked and Runtime (unchecked). The 5 fields in the enum are:

• HTTP Error Code for translating between REST and JAVA. Typically the numbers used are:
• • 500: internal error
  • 501: not implemented
  • 503: Service not available
  • 400: invalid parameters
  • 401: unauthorized
  • 404: not found
  • 405: method not allowed
  • 409: data conflict errors, for example an item is already defined
• Error Message Id: to uniquely identify the message
• Error Message Text: includes placeholder to allow additional values to be captured
• SystemAction: describes the result of the error
• UserAction: describes how a user should correct the error

Enum Constant Summary

Enum Constants

Enum Constant and Description
ENTITY_NOT_KNOWN
INVALID_VALUE
NO_GUID
RELATIONSHIP_NOT_KNOWN
TROUBLE_AT_MILL

Method Summary

Modifier and Type	Method and Description
ExceptionMessageDefinition	getMessageDefinition() Retrieve a message definition object for an exception.
ExceptionMessageDefinition	getMessageDefinition(String... params) Retrieve a message definition object for an exception.
String	toString() toString() JSON-style
static RexErrorCode	valueOf(String name) Returns the enum constant of this type with the specified name.
static RexErrorCode[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NO_GUID

public static final RexErrorCode NO_GUID

INVALID_VALUE

public static final RexErrorCode INVALID_VALUE

ENTITY_NOT_KNOWN

public static final RexErrorCode ENTITY_NOT_KNOWN

RELATIONSHIP_NOT_KNOWN

public static final RexErrorCode RELATIONSHIP_NOT_KNOWN

TROUBLE_AT_MILL

public static final RexErrorCode TROUBLE_AT_MILL

Method Detail

values

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

Returns:

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

valueOf

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

getMessageDefinition

public ExceptionMessageDefinition getMessageDefinition()

Retrieve a message definition object for an exception. This method is used when there are no message inserts.

Specified by:

getMessageDefinition in interface ExceptionMessageSet

Returns:

message definition object.

getMessageDefinition

public ExceptionMessageDefinition getMessageDefinition(String... params)

Retrieve a message definition object for an exception. This method is used when there are values to be inserted into the message.

Specified by:

getMessageDefinition in interface ExceptionMessageSet

Parameters:

params - array of parameters (all strings). They are inserted into the message according to the numbering in the message text.

Returns:

message definition object.

toString

public String toString()

toString() JSON-style

Overrides:

toString in class Enum<RexErrorCode>

Returns:

string description