org.odpi.openmetadata.commonservices.ocf.metadatamanagement.ffdc

Enum OMAGOCFErrorCode

java.lang.Object

java.lang.Enum<OMAGOCFErrorCode>

org.odpi.openmetadata.commonservices.ocf.metadatamanagement.ffdc.OMAGOCFErrorCode

All Implemented Interfaces:

Serializable, Comparable<OMAGOCFErrorCode>, ExceptionMessageSet

public enum OMAGOCFErrorCode
extends Enum<OMAGOCFErrorCode>
implements ExceptionMessageSet

The OMAGOCFErrorCode is used to define first failure data capture (FFDC) for errors that occur when working with OCF Beans. 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 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 consumer should correct the error

Enum Constant Summary

Enum Constants

Enum Constant and Description
BAD_CLASSIFICATION_PROPERTIES
BAD_INTEGRATOR_NAME
INTEGRATOR_NOT_RETURNED
NO_ASSET_PROPERTIES
NULL_CLASSIFICATION_NAME
NULL_CONNECTION_PARAMETER
NULL_CONNECTOR_RETURNED
OMRS_NOT_INITIALIZED
WRONG_TYPE_OF_CONNECTOR

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

NULL_CONNECTION_PARAMETER

public static final OMAGOCFErrorCode NULL_CONNECTION_PARAMETER

NO_ASSET_PROPERTIES

public static final OMAGOCFErrorCode NO_ASSET_PROPERTIES

NULL_CLASSIFICATION_NAME

public static final OMAGOCFErrorCode NULL_CLASSIFICATION_NAME

BAD_CLASSIFICATION_PROPERTIES

public static final OMAGOCFErrorCode BAD_CLASSIFICATION_PROPERTIES

INTEGRATOR_NOT_RETURNED

public static final OMAGOCFErrorCode INTEGRATOR_NOT_RETURNED

BAD_INTEGRATOR_NAME

public static final OMAGOCFErrorCode BAD_INTEGRATOR_NAME

OMRS_NOT_INITIALIZED

public static final OMAGOCFErrorCode OMRS_NOT_INITIALIZED

NULL_CONNECTOR_RETURNED

public static final OMAGOCFErrorCode NULL_CONNECTOR_RETURNED

WRONG_TYPE_OF_CONNECTOR

public static final OMAGOCFErrorCode WRONG_TYPE_OF_CONNECTOR

Method Detail

values

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

Returns:

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

valueOf

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