Package org.odpi.openmetadata.adapters.connectors.jacquard.tabulardatasets.ffdc

Enum Class TabularDataErrorCode

java.lang.Object

java.lang.Enum<TabularDataErrorCode>

org.odpi.openmetadata.adapters.connectors.jacquard.tabulardatasets.ffdc.TabularDataErrorCode

All Implemented Interfaces:

Serializable, Comparable<TabularDataErrorCode>, Constable, ExceptionMessageSet

public enum TabularDataErrorCode
extends Enum<TabularDataErrorCode>
implements ExceptionMessageSet

The ReferenceDataErrorCode is used to define first failure data capture (FFDC) for errors that occur when working with the Reference Data Connectors. It is used in conjunction with both Checked and Runtime (unchecked) exceptions. The 5 fields in the enum are:

• HTTP Error Code - for translating between REST and JAVA - Typically the numbers used are:
• • 500 - internal error
  • 400 - invalid parameters
  • 404 - not found
  • 409 - data conflict errors - eg item already defined
• Error Message Identifier - 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 consumer should correct the error

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
INVALID_ELEMENT	REFERENCE-DATA-CONNECTORS-500-002 - The {0} Reference Data Connector received an unexpected exception {1} during method {2}; the error message was: {3}
NULL_CLIENT_USER_ID	REFERENCE-DATA-CONNECTORS-400-003 - Reference Data Connector {0} has been configured without a userId needed to call the OMAG Server Platform.
NULL_PRODUCT_DEFINITION	REFERENCE-DATA-CONNECTORS-500-004 - Product definition is null for connector {0} in method {1}
NULL_RECORD	REFERENCE-DATA-CONNECTORS-400-004 - Reference Data Connector {0} has no data at record {1}.
NULL_SERVER_NAME	REFERENCE-DATA-CONNECTORS-400-002 - Reference Data Connector {0} has been configured without the name of the OMAG Server to call
NULL_URL	REFERENCE-DATA-CONNECTORS-400-001 - Reference Data Connector {0} has been configured without the URL to the OMAG Server Platform
UNEXPECTED_EXCEPTION	REFERENCE-DATA-CONNECTORS-500-001 - The {0} Reference Data Connector received an unexpected exception {1} during method {2}; the error message was: {3}
UNMAPPED_COLUMN	REFERENCE-DATA-CONNECTORS-500-003 - The {0} Reference Data Connector received an unexpected exception {1} during method {2}; the error message was: {3}
WRONG_NUMBER_OF_COLUMNS	REFERENCE-DATA-CONNECTORS-400-005 - Reference Data Connector {0} has been passed {1} columns on the {2} method for record number {3}.

Method Summary

Modifier and Type	Method	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()	JSON-style toString
static TabularDataErrorCode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static TabularDataErrorCode[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NULL_URL

public static final TabularDataErrorCode NULL_URL

REFERENCE-DATA-CONNECTORS-400-001 - Reference Data Connector {0} has been configured without the URL to the OMAG Server Platform

NULL_SERVER_NAME

public static final TabularDataErrorCode NULL_SERVER_NAME

REFERENCE-DATA-CONNECTORS-400-002 - Reference Data Connector {0} has been configured without the name of the OMAG Server to call

NULL_CLIENT_USER_ID

public static final TabularDataErrorCode NULL_CLIENT_USER_ID

REFERENCE-DATA-CONNECTORS-400-003 - Reference Data Connector {0} has been configured without a userId needed to call the OMAG Server Platform.

NULL_RECORD

public static final TabularDataErrorCode NULL_RECORD

REFERENCE-DATA-CONNECTORS-400-004 - Reference Data Connector {0} has no data at record {1}. The data set size is {2}

WRONG_NUMBER_OF_COLUMNS

public static final TabularDataErrorCode WRONG_NUMBER_OF_COLUMNS

REFERENCE-DATA-CONNECTORS-400-005 - Reference Data Connector {0} has been passed {1} columns on the {2} method for record number {3}. The data set width is {4}

UNEXPECTED_EXCEPTION

public static final TabularDataErrorCode UNEXPECTED_EXCEPTION

REFERENCE-DATA-CONNECTORS-500-001 - The {0} Reference Data Connector received an unexpected exception {1} during method {2}; the error message was: {3}

INVALID_ELEMENT

public static final TabularDataErrorCode INVALID_ELEMENT

REFERENCE-DATA-CONNECTORS-500-002 - The {0} Reference Data Connector received an unexpected exception {1} during method {2}; the error message was: {3}

UNMAPPED_COLUMN

public static final TabularDataErrorCode UNMAPPED_COLUMN

REFERENCE-DATA-CONNECTORS-500-003 - The {0} Reference Data Connector received an unexpected exception {1} during method {2}; the error message was: {3}

NULL_PRODUCT_DEFINITION

public static final TabularDataErrorCode NULL_PRODUCT_DEFINITION

REFERENCE-DATA-CONNECTORS-500-004 - Product definition is null for connector {0} in method {1}

Method Details

values

public static TabularDataErrorCode[] 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

public static TabularDataErrorCode valueOf(String name)

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 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()

JSON-style toString

Overrides:

toString in class Enum<TabularDataErrorCode>

Returns:

string of property names and values for this enum