org.odpi.openmetadata.accessservices.assetowner.ffdc

Enum AssetOwnerErrorCode

java.lang.Object

java.lang.Enum<AssetOwnerErrorCode>

org.odpi.openmetadata.accessservices.assetowner.ffdc.AssetOwnerErrorCode

All Implemented Interfaces:

Serializable, Comparable<AssetOwnerErrorCode>, ExceptionMessageSet

public enum AssetOwnerErrorCode
extends Enum<AssetOwnerErrorCode>
implements ExceptionMessageSet

The AssetOwnerErrorCode is used to define first failure data capture (FFDC) for errors that occur when working with the Asset Owner OMAS Services. 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 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
ASSET_NOT_FOUND
BAD_CONFIG
CLIENT_SIDE_REST_API_ERROR
CONNECTION_NOT_FOUND
EMPTY_PAGE_SIZE
INVALID_PROPERTY
MULTIPLE_ENTITIES_FOUND
MULTIPLE_RELATIONSHIPS_FOUND
NEGATIVE_START_FROM
NO_CONNECTED_ASSET
NO_METADATA_COLLECTION
NO_RELATIONSHIPS_FOUND
NULL_ARRAY_PARAMETER
NULL_CONNECTION_PARAMETER
NULL_CONNECTION_RETURNED
NULL_CONNECTOR_RETURNED
NULL_END2_RETURNED
NULL_ENTITY_RETURNED
NULL_ENUM
NULL_GUID
NULL_NAME
NULL_RESPONSE_FROM_API
NULL_USER_ID
OMRS_NOT_AVAILABLE
OMRS_NOT_INITIALIZED
PROPERTY_SERVER_ERROR
PROXY_CONNECTION_FOUND
PROXY_ENTITY_FOUND
SERVER_NOT_AVAILABLE
SERVER_URL_MALFORMED
SERVER_URL_NOT_SPECIFIED
SERVICE_NOT_INITIALIZED
TOO_MANY_CONNECTIONS
UNKNOWN_ASSET
UNKNOWN_ENTITY
USER_NOT_AUTHORIZED

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

SERVER_URL_NOT_SPECIFIED

public static final AssetOwnerErrorCode SERVER_URL_NOT_SPECIFIED

SERVER_URL_MALFORMED

public static final AssetOwnerErrorCode SERVER_URL_MALFORMED

NULL_USER_ID

public static final AssetOwnerErrorCode NULL_USER_ID

NULL_GUID

public static final AssetOwnerErrorCode NULL_GUID

NULL_NAME

public static final AssetOwnerErrorCode NULL_NAME

NO_CONNECTED_ASSET

public static final AssetOwnerErrorCode NO_CONNECTED_ASSET

TOO_MANY_CONNECTIONS

public static final AssetOwnerErrorCode TOO_MANY_CONNECTIONS

USER_NOT_AUTHORIZED

public static final AssetOwnerErrorCode USER_NOT_AUTHORIZED

PROPERTY_SERVER_ERROR

public static final AssetOwnerErrorCode PROPERTY_SERVER_ERROR

NULL_ENUM

public static final AssetOwnerErrorCode NULL_ENUM

NULL_CONNECTION_PARAMETER

public static final AssetOwnerErrorCode NULL_CONNECTION_PARAMETER

NEGATIVE_START_FROM

public static final AssetOwnerErrorCode NEGATIVE_START_FROM

EMPTY_PAGE_SIZE

public static final AssetOwnerErrorCode EMPTY_PAGE_SIZE

BAD_CONFIG

public static final AssetOwnerErrorCode BAD_CONFIG

NULL_ARRAY_PARAMETER

public static final AssetOwnerErrorCode NULL_ARRAY_PARAMETER

INVALID_PROPERTY

public static final AssetOwnerErrorCode INVALID_PROPERTY

SERVER_NOT_AVAILABLE

public static final AssetOwnerErrorCode SERVER_NOT_AVAILABLE

OMRS_NOT_INITIALIZED

public static final AssetOwnerErrorCode OMRS_NOT_INITIALIZED

OMRS_NOT_AVAILABLE

public static final AssetOwnerErrorCode OMRS_NOT_AVAILABLE

NO_METADATA_COLLECTION

public static final AssetOwnerErrorCode NO_METADATA_COLLECTION

CONNECTION_NOT_FOUND

public static final AssetOwnerErrorCode CONNECTION_NOT_FOUND

ASSET_NOT_FOUND

public static final AssetOwnerErrorCode ASSET_NOT_FOUND

PROXY_CONNECTION_FOUND

public static final AssetOwnerErrorCode PROXY_CONNECTION_FOUND

UNKNOWN_ASSET

public static final AssetOwnerErrorCode UNKNOWN_ASSET

PROXY_ENTITY_FOUND

public static final AssetOwnerErrorCode PROXY_ENTITY_FOUND

MULTIPLE_RELATIONSHIPS_FOUND

public static final AssetOwnerErrorCode MULTIPLE_RELATIONSHIPS_FOUND

UNKNOWN_ENTITY

public static final AssetOwnerErrorCode UNKNOWN_ENTITY

NO_RELATIONSHIPS_FOUND

public static final AssetOwnerErrorCode NO_RELATIONSHIPS_FOUND

NULL_ENTITY_RETURNED

public static final AssetOwnerErrorCode NULL_ENTITY_RETURNED

MULTIPLE_ENTITIES_FOUND

public static final AssetOwnerErrorCode MULTIPLE_ENTITIES_FOUND

NULL_CONNECTION_RETURNED

public static final AssetOwnerErrorCode NULL_CONNECTION_RETURNED

NULL_CONNECTOR_RETURNED

public static final AssetOwnerErrorCode NULL_CONNECTOR_RETURNED

NULL_END2_RETURNED

public static final AssetOwnerErrorCode NULL_END2_RETURNED

NULL_RESPONSE_FROM_API

public static final AssetOwnerErrorCode NULL_RESPONSE_FROM_API

CLIENT_SIDE_REST_API_ERROR

public static final AssetOwnerErrorCode CLIENT_SIDE_REST_API_ERROR

SERVICE_NOT_INITIALIZED

public static final AssetOwnerErrorCode SERVICE_NOT_INITIALIZED

Method Detail

values

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

Returns:

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

valueOf

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