org.odpi.openmetadata.adapters.repositoryservices.igc.repositoryconnector

Enum IGCOMRSErrorCode

java.lang.Object

java.lang.Enum<IGCOMRSErrorCode>

org.odpi.openmetadata.adapters.repositoryservices.igc.repositoryconnector.IGCOMRSErrorCode

All Implemented Interfaces:

Serializable, Comparable<IGCOMRSErrorCode>

public enum IGCOMRSErrorCode
extends Enum<IGCOMRSErrorCode>

Enum Constant Summary

Enum Constants

Enum Constant and Description
CLASSIFICATION_EXCEEDS_REPOSITORY
CLASSIFICATION_INSUFFICIENT_PROPERTIES
CLASSIFICATION_NOT_APPLICABLE
CLASSIFICATION_NOT_EDITABLE
CLASSIFICATION_NOT_FOUND
OMRS_BUNDLE_FAILURE
REST_CLIENT_FAILURE

Method Summary

Modifier and Type	Method and Description
String	getErrorMessageId() Returns the unique identifier for the error message.
String	getFormattedErrorMessage(String... params) Returns the error message with the placeholders filled out with the supplied parameters.
int	getHTTPErrorCode()
String	getSystemAction() Returns a description of the action taken by the system when the condition that caused this exception was detected.
String	getUnformattedErrorMessage() Returns the error message with placeholders for specific details.
String	getUserAction() Returns instructions of how to resolve the issue reported in this exception.
static IGCOMRSErrorCode	valueOf(String name) Returns the enum constant of this type with the specified name.
static IGCOMRSErrorCode[]	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

REST_CLIENT_FAILURE

public static final IGCOMRSErrorCode REST_CLIENT_FAILURE

OMRS_BUNDLE_FAILURE

public static final IGCOMRSErrorCode OMRS_BUNDLE_FAILURE

CLASSIFICATION_INSUFFICIENT_PROPERTIES

public static final IGCOMRSErrorCode CLASSIFICATION_INSUFFICIENT_PROPERTIES

CLASSIFICATION_EXCEEDS_REPOSITORY

public static final IGCOMRSErrorCode CLASSIFICATION_EXCEEDS_REPOSITORY

CLASSIFICATION_NOT_FOUND

public static final IGCOMRSErrorCode CLASSIFICATION_NOT_FOUND

CLASSIFICATION_NOT_EDITABLE

public static final IGCOMRSErrorCode CLASSIFICATION_NOT_EDITABLE

CLASSIFICATION_NOT_APPLICABLE

public static final IGCOMRSErrorCode CLASSIFICATION_NOT_APPLICABLE

Method Detail

values

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

Returns:

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

valueOf

public static IGCOMRSErrorCode 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

getHTTPErrorCode

public int getHTTPErrorCode()

getErrorMessageId

public String getErrorMessageId()

Returns the unique identifier for the error message.

Returns:

errorMessageId

getUnformattedErrorMessage

public String getUnformattedErrorMessage()

Returns the error message with placeholders for specific details.

Returns:

errorMessage (unformatted)

getFormattedErrorMessage

public String getFormattedErrorMessage(String... params)

Returns the error message with the placeholders filled out with the supplied parameters.

Parameters:

params - - strings that plug into the placeholders in the errorMessage

Returns:

errorMessage (formatted with supplied parameters)

getSystemAction

public String getSystemAction()

Returns a description of the action taken by the system when the condition that caused this exception was detected.

Returns:

systemAction

getUserAction

public String getUserAction()

Returns instructions of how to resolve the issue reported in this exception.

Returns:

userAction