Package org.odpi.openmetadata.accessservices.assetcatalog.exception

Enum Class AssetCatalogErrorCode

java.lang.Object

java.lang.Enum<AssetCatalogErrorCode>

org.odpi.openmetadata.accessservices.assetcatalog.exception.AssetCatalogErrorCode

All Implemented Interfaces:

Serializable, Comparable<AssetCatalogErrorCode>, Constable, ExceptionMessageSet

public enum AssetCatalogErrorCode
extends Enum<AssetCatalogErrorCode>
implements ExceptionMessageSet

The AssetCatalogErrorCode is used to define first failure data capture (FFDC) for errors that occur when working with the Asset Catalog 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 an AssetConsumerInterface 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
ASSET_NEIGHBORHOOD_NOT_FOUND	OMAS-ASSET-CATALOG-404-011 The error indicates that the system is unable to retrieve the neighbourhood for the given asset.
NO_ASSET_FROM_NEIGHBORHOOD_NOT_FOUND	OMAS-ASSET-CATALOG-404-012 The error indicates that the system is unable to retrieve the assets neighborhood from the specified asset identifier.
OMRS_NOT_INITIALIZED	OMAS-ASSET-CATALOG-404-001 The error indicates that the open metadata repository services are not initialized for the mentioned server.
SERVICE_NOT_INITIALIZED	OMAS-ASSET-CATALOG-503-001 The error indicates that the server has received a call to one of its open metadata access services but is unable to process it because the access service is not active for the requested server.
TYPE_DEF_NOT_FOUND	OMAS-ASSET-CATALOG-404-017 The error indicates that the system is unable to retrieve assets of an unknown type/s.

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

OMRS_NOT_INITIALIZED

public static final AssetCatalogErrorCode OMRS_NOT_INITIALIZED

OMAS-ASSET-CATALOG-404-001 The error indicates that the open metadata repository services are not initialized for the mentioned server.

ASSET_NEIGHBORHOOD_NOT_FOUND

public static final AssetCatalogErrorCode ASSET_NEIGHBORHOOD_NOT_FOUND

OMAS-ASSET-CATALOG-404-011 The error indicates that the system is unable to retrieve the neighbourhood for the given asset.

NO_ASSET_FROM_NEIGHBORHOOD_NOT_FOUND

public static final AssetCatalogErrorCode NO_ASSET_FROM_NEIGHBORHOOD_NOT_FOUND

OMAS-ASSET-CATALOG-404-012 The error indicates that the system is unable to retrieve the assets neighborhood from the specified asset identifier.

TYPE_DEF_NOT_FOUND

public static final AssetCatalogErrorCode TYPE_DEF_NOT_FOUND

OMAS-ASSET-CATALOG-404-017 The error indicates that the system is unable to retrieve assets of an unknown type/s.

SERVICE_NOT_INITIALIZED

public static final AssetCatalogErrorCode SERVICE_NOT_INITIALIZED

OMAS-ASSET-CATALOG-503-001 The error indicates that the server has received a call to one of its open metadata access services but is unable to process it because the access service is not active for the requested server.

Method Details

values

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

Returns:

string of property names and values for this enum