UIAdminErrorCode (User Interface Administration Services API 1.1 API)

java.lang.Object
- java.lang.Enum<UIAdminErrorCode>
- - org.odpi.openmetadata.userinterface.adminservices.ffdc.UIAdminErrorCode

All Implemented Interfaces:

Serializable, Comparable<UIAdminErrorCode>
```
public enum UIAdminErrorCode
extends Enum<UIAdminErrorCode>
```
The UIAdminErrorCode is used to define first failure data capture (FFDC) for errors that occur within the UI Server It is used in conjunction with UI Exceptions, both Checked and Runtime (unchecked). The 5 fields in the enum are:
- HTTP Error Code - for translating between REST and JAVA - Typically the numbers used are:
- - 500 - internal error
  - 501 - not implemented
  - 503 - Service not available
  - 400 - invalid parameters
  - 401 - unauthorized
  - 404 - not found
  - 405 - method not allowed
  - 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 user should correct the error

Enum Constant Summary

Enum Constants
Enum Constant and Description
`BAD_CONFIG_FILE`
`BAD_MAX_PAGE_SIZE`
`DUPLICATE_GOVERNANCE_SERVERS`
`EMPTY_CONFIGURATION`
`INCOMPATIBLE_CONFIG_FILE`
`INCOMPATIBLE_SERVER_NAMES`
`INVALID_GOVERNANCE_SERVER_URL`
`INVALID_GOVERNANCE_SERVICE_NAME`
`INVALID_METADATA_SERVER_URL`
`NULL_CONNECTION`
`NULL_GOVERNANCE_SERVER_NAME`
`NULL_GOVERNANCE_SERVER_URL`
`NULL_GOVERNANCE_SERVICE_NAME`
`NULL_LOCAL_SERVER_NAME`
`NULL_METADATA_COLLECTION_NAME`
`NULL_METADATA_SERVER_NAME`
`NULL_METADATA_SERVER_URL`
`NULL_PLATFORM_CONNECTION`
`NULL_REPOSITORY_CONFIG`
`NULL_SERVER_CONFIG`
`NULL_USER_NAME`
`UNEXPECTED_EXCEPTION`
`UNEXPECTED_PLATFORM_EXCEPTION`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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 UIAdminErrorCode`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static UIAdminErrorCode[]`	`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_LOCAL_SERVER_NAME
```
public static final UIAdminErrorCode NULL_LOCAL_SERVER_NAME
```
  - INCOMPATIBLE_SERVER_NAMES
```
public static final UIAdminErrorCode INCOMPATIBLE_SERVER_NAMES
```
  - NULL_USER_NAME
```
public static final UIAdminErrorCode NULL_USER_NAME
```
  - NULL_GOVERNANCE_SERVICE_NAME
```
public static final UIAdminErrorCode NULL_GOVERNANCE_SERVICE_NAME
```
  - INVALID_GOVERNANCE_SERVICE_NAME
```
public static final UIAdminErrorCode INVALID_GOVERNANCE_SERVICE_NAME
```
  - NULL_METADATA_SERVER_NAME
```
public static final UIAdminErrorCode NULL_METADATA_SERVER_NAME
```
  - INVALID_METADATA_SERVER_URL
```
public static final UIAdminErrorCode INVALID_METADATA_SERVER_URL
```
  - NULL_METADATA_SERVER_URL
```
public static final UIAdminErrorCode NULL_METADATA_SERVER_URL
```
  - NULL_GOVERNANCE_SERVER_URL
```
public static final UIAdminErrorCode NULL_GOVERNANCE_SERVER_URL
```
  - INVALID_GOVERNANCE_SERVER_URL
```
public static final UIAdminErrorCode INVALID_GOVERNANCE_SERVER_URL
```
  - NULL_SERVER_CONFIG
```
public static final UIAdminErrorCode NULL_SERVER_CONFIG
```
  - NULL_REPOSITORY_CONFIG
```
public static final UIAdminErrorCode NULL_REPOSITORY_CONFIG
```
  - BAD_CONFIG_FILE
```
public static final UIAdminErrorCode BAD_CONFIG_FILE
```
  - BAD_MAX_PAGE_SIZE
```
public static final UIAdminErrorCode BAD_MAX_PAGE_SIZE
```
  - NULL_METADATA_COLLECTION_NAME
```
public static final UIAdminErrorCode NULL_METADATA_COLLECTION_NAME
```
  - NULL_GOVERNANCE_SERVER_NAME
```
public static final UIAdminErrorCode NULL_GOVERNANCE_SERVER_NAME
```
  - EMPTY_CONFIGURATION
```
public static final UIAdminErrorCode EMPTY_CONFIGURATION
```
  - DUPLICATE_GOVERNANCE_SERVERS
```
public static final UIAdminErrorCode DUPLICATE_GOVERNANCE_SERVERS
```
  - INCOMPATIBLE_CONFIG_FILE
```
public static final UIAdminErrorCode INCOMPATIBLE_CONFIG_FILE
```
  - NULL_CONNECTION
```
public static final UIAdminErrorCode NULL_CONNECTION
```
  - NULL_PLATFORM_CONNECTION
```
public static final UIAdminErrorCode NULL_PLATFORM_CONNECTION
```
  - UNEXPECTED_EXCEPTION
```
public static final UIAdminErrorCode UNEXPECTED_EXCEPTION
```
  - UNEXPECTED_PLATFORM_EXCEPTION
```
public static final UIAdminErrorCode UNEXPECTED_PLATFORM_EXCEPTION
```
- Method Detail
  - values
```
public static UIAdminErrorCode[] 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 (UIAdminErrorCode c : UIAdminErrorCode.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static UIAdminErrorCode 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

Enum UIAdminErrorCode

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

NULL_LOCAL_SERVER_NAME

INCOMPATIBLE_SERVER_NAMES

NULL_USER_NAME

NULL_GOVERNANCE_SERVICE_NAME

INVALID_GOVERNANCE_SERVICE_NAME

NULL_METADATA_SERVER_NAME

INVALID_METADATA_SERVER_URL

NULL_METADATA_SERVER_URL

NULL_GOVERNANCE_SERVER_URL

INVALID_GOVERNANCE_SERVER_URL

NULL_SERVER_CONFIG

NULL_REPOSITORY_CONFIG

BAD_CONFIG_FILE

BAD_MAX_PAGE_SIZE

NULL_METADATA_COLLECTION_NAME

NULL_GOVERNANCE_SERVER_NAME

EMPTY_CONFIGURATION

DUPLICATE_GOVERNANCE_SERVERS

INCOMPATIBLE_CONFIG_FILE

NULL_CONNECTION

NULL_PLATFORM_CONNECTION

UNEXPECTED_EXCEPTION

UNEXPECTED_PLATFORM_EXCEPTION

Method Detail

values

valueOf

getHTTPErrorCode

getErrorMessageId

getUnformattedErrorMessage

getFormattedErrorMessage

getSystemAction

getUserAction