org.odpi.openmetadata.accessservices.analyticsmodeling.ffdc

Enum AnalyticsModelingErrorCode

java.lang.Object

java.lang.Enum<AnalyticsModelingErrorCode>

org.odpi.openmetadata.accessservices.analyticsmodeling.ffdc.AnalyticsModelingErrorCode

All Implemented Interfaces:

Serializable, Comparable<AnalyticsModelingErrorCode>, ExceptionMessageSet

public enum AnalyticsModelingErrorCode
extends Enum<AnalyticsModelingErrorCode>
implements ExceptionMessageSet

The AnalyticsModelingErrorCode is definition of the first failure data capture (FFDC) for errors that occur when working with the Analytics Modeling OMAS Services. It is used in conjunction with both Checked and Runtime (unchecked) exceptions.

The fields in the enum are defined in ExceptionMessageDefinition. The object is used to build exception augmented with parameters to identify related context:

• 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 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 AssetConsumerInterface should correct the error

Enum Constant Summary

Enum Constants

Enum Constant and Description
ADD_RELATIONSHIP_EXCEPTION
BAD_CONFIG
CLASSIFICATION_EXCEPTION
DELETE_ENTITY_EXCEPTION
ENTITY_NOT_FOUND_EXCEPTION
ERROR_INITIALIZING_ANALYTICS_MODELING_TOPIC_CONNECTION
FAILED_CREATE_ARTIFACT
FAILED_CREATE_BEAN
FAILED_CREATE_SERVER_CAPABILITY
FAILED_FETCH_DATABASE_SCHEMAS
FAILED_FETCH_DATABASES
FAILED_FETCH_SCHEMAS_TABLES
FAILED_FIND_DATABASE_SCHEMA
FAILED_UPDATE_ARTIFACT
GET_ENTITY_EXCEPTION
GET_RELATIONSHIP_EXCEPTION
INCORRECT_ARTIFACT_DEFINITION
INCORRECT_MODEL_EXCEPTION
INVALID_REQUEST_PARAMER
MISSING_BEAN_CLASS
MISSING_BEAN_PROPERTIES
NULL_TOPIC_CONNECTOR
SCHEMA_UNKNOWN
SERVICE_INSTANCE_FAILURE
SERVICE_NOT_INITIALIZED
UNEXPECTED_CLASS
UNEXPECTED_EXCEPTION
UNKNOWN_ERROR
UPDATE_PROPERTY_EXCEPTION

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.
static AnalyticsModelingErrorCode	valueOf(String name) Returns the enum constant of this type with the specified name.
static AnalyticsModelingErrorCode[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ADD_RELATIONSHIP_EXCEPTION

public static final AnalyticsModelingErrorCode ADD_RELATIONSHIP_EXCEPTION

GET_ENTITY_EXCEPTION

public static final AnalyticsModelingErrorCode GET_ENTITY_EXCEPTION

GET_RELATIONSHIP_EXCEPTION

public static final AnalyticsModelingErrorCode GET_RELATIONSHIP_EXCEPTION

SERVICE_NOT_INITIALIZED

public static final AnalyticsModelingErrorCode SERVICE_NOT_INITIALIZED

BAD_CONFIG

public static final AnalyticsModelingErrorCode BAD_CONFIG

ENTITY_NOT_FOUND_EXCEPTION

public static final AnalyticsModelingErrorCode ENTITY_NOT_FOUND_EXCEPTION

INCORRECT_MODEL_EXCEPTION

public static final AnalyticsModelingErrorCode INCORRECT_MODEL_EXCEPTION

DELETE_ENTITY_EXCEPTION

public static final AnalyticsModelingErrorCode DELETE_ENTITY_EXCEPTION

NULL_TOPIC_CONNECTOR

public static final AnalyticsModelingErrorCode NULL_TOPIC_CONNECTOR

SCHEMA_UNKNOWN

public static final AnalyticsModelingErrorCode SCHEMA_UNKNOWN

UPDATE_PROPERTY_EXCEPTION

public static final AnalyticsModelingErrorCode UPDATE_PROPERTY_EXCEPTION

CLASSIFICATION_EXCEPTION

public static final AnalyticsModelingErrorCode CLASSIFICATION_EXCEPTION

ERROR_INITIALIZING_ANALYTICS_MODELING_TOPIC_CONNECTION

public static final AnalyticsModelingErrorCode ERROR_INITIALIZING_ANALYTICS_MODELING_TOPIC_CONNECTION

SERVICE_INSTANCE_FAILURE

public static final AnalyticsModelingErrorCode SERVICE_INSTANCE_FAILURE

INVALID_REQUEST_PARAMER

public static final AnalyticsModelingErrorCode INVALID_REQUEST_PARAMER

FAILED_FETCH_DATABASES

public static final AnalyticsModelingErrorCode FAILED_FETCH_DATABASES

FAILED_FETCH_DATABASE_SCHEMAS

public static final AnalyticsModelingErrorCode FAILED_FETCH_DATABASE_SCHEMAS

FAILED_FIND_DATABASE_SCHEMA

public static final AnalyticsModelingErrorCode FAILED_FIND_DATABASE_SCHEMA

FAILED_FETCH_SCHEMAS_TABLES

public static final AnalyticsModelingErrorCode FAILED_FETCH_SCHEMAS_TABLES

UNEXPECTED_CLASS

public static final AnalyticsModelingErrorCode UNEXPECTED_CLASS

FAILED_CREATE_BEAN

public static final AnalyticsModelingErrorCode FAILED_CREATE_BEAN

MISSING_BEAN_CLASS

public static final AnalyticsModelingErrorCode MISSING_BEAN_CLASS

MISSING_BEAN_PROPERTIES

public static final AnalyticsModelingErrorCode MISSING_BEAN_PROPERTIES

INCORRECT_ARTIFACT_DEFINITION

public static final AnalyticsModelingErrorCode INCORRECT_ARTIFACT_DEFINITION

FAILED_CREATE_ARTIFACT

public static final AnalyticsModelingErrorCode FAILED_CREATE_ARTIFACT

FAILED_CREATE_SERVER_CAPABILITY

public static final AnalyticsModelingErrorCode FAILED_CREATE_SERVER_CAPABILITY

FAILED_UPDATE_ARTIFACT

public static final AnalyticsModelingErrorCode FAILED_UPDATE_ARTIFACT

UNEXPECTED_EXCEPTION

public static final AnalyticsModelingErrorCode UNEXPECTED_EXCEPTION

UNKNOWN_ERROR

public static final AnalyticsModelingErrorCode UNKNOWN_ERROR

Method Detail

values

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

Returns:

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

valueOf

public static AnalyticsModelingErrorCode 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.