OCFErrorCode (Open Connector Framework (OCF) 2.5 API)

java.lang.Object
- java.lang.Enum<OCFErrorCode>
- - org.odpi.openmetadata.frameworks.connectors.ffdc.OCFErrorCode

All Implemented Interfaces:

Serializable, Comparable<OCFErrorCode>, ExceptionMessageSet
```
public enum OCFErrorCode
extends Enum<OCFErrorCode>
implements ExceptionMessageSet
```
The OCF error code is used to define first failure data capture (FFDC) for errors that occur when working with OCF Connectors. It is used in conjunction with all OCF 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
  - 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 user should correct the error

Enum Constant Summary

Enum Constants
Enum Constant and Description
`CAUGHT_EXCEPTION`
`CAUGHT_EXCEPTION_WITHMSG`
`INCOMPLETE_CONNECTOR`
`INTERNAL_ERROR`
`INVALID_CONNECTOR`
`INVALID_CONNECTOR_PROVIDER`
`INVALID_PROPERTY_NAMES`
`INVALID_VIRTUAL_CONNECTION`
`MALFORMED_ENDPOINT`
`NO_ITERATOR`
`NO_MORE_ELEMENTS`
`NOT_CONNECTOR`
`NOT_CONNECTOR_PROVIDER`
`NOT_IMPLEMENTED`
`NOT_VIRTUAL_CONNECTOR`
`NULL_CLASSIFICATION_NAME`
`NULL_CONNECTION`
`NULL_CONNECTOR`
`NULL_CONNECTOR_CLASS`
`NULL_CONNECTOR_PROVIDER`
`NULL_CONNECTOR_TYPE`
`NULL_ENDPOINT_IN_CONNECTION`
`NULL_PROPERTY_NAME`
`NULL_SECURED_PROPERTY_NAME`
`NULL_TAG_NAME`
`PROPERTIES_NOT_AVAILABLE`
`UNABLE_TO_REMOVE`
`UNKNOWN_CONNECTOR`
`UNKNOWN_CONNECTOR_PROVIDER`
`UNKNOWN_ENDPOINT`
`UNKNOWN_ERROR`
`UNKNOWN_SCHEMA_TYPE`
`UNNAMED_CONNECTION`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`String`	`getErrorMessageId()` Deprecated.
`String`	`getFormattedErrorMessage(String... params)` Deprecated.
`int`	`getHTTPErrorCode()` Deprecated.
`ExceptionMessageDefinition`	`getMessageDefinition()` Retrieve a message definition object for an exception.
`ExceptionMessageDefinition`	`getMessageDefinition(String... params)` Retrieve a message definition object for an exception.
`String`	`getSystemAction()` Deprecated.
`String`	`getUserAction()` Deprecated.
`static OCFErrorCode`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static OCFErrorCode[]`	`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
```
public static final OCFErrorCode NULL_CONNECTION
```
  - UNNAMED_CONNECTION
```
public static final OCFErrorCode UNNAMED_CONNECTION
```
  - NULL_CONNECTOR_TYPE
```
public static final OCFErrorCode NULL_CONNECTOR_TYPE
```
  - NULL_CONNECTOR_PROVIDER
```
public static final OCFErrorCode NULL_CONNECTOR_PROVIDER
```
  - UNKNOWN_CONNECTOR_PROVIDER
```
public static final OCFErrorCode UNKNOWN_CONNECTOR_PROVIDER
```
  - NOT_CONNECTOR_PROVIDER
```
public static final OCFErrorCode NOT_CONNECTOR_PROVIDER
```
  - INVALID_CONNECTOR_PROVIDER
```
public static final OCFErrorCode INVALID_CONNECTOR_PROVIDER
```
  - NULL_ENDPOINT_IN_CONNECTION
```
public static final OCFErrorCode NULL_ENDPOINT_IN_CONNECTION
```
  - MALFORMED_ENDPOINT
```
public static final OCFErrorCode MALFORMED_ENDPOINT
```
  - NULL_PROPERTY_NAME
```
public static final OCFErrorCode NULL_PROPERTY_NAME
```
  - INVALID_PROPERTY_NAMES
```
public static final OCFErrorCode INVALID_PROPERTY_NAMES
```
  - NULL_SECURED_PROPERTY_NAME
```
public static final OCFErrorCode NULL_SECURED_PROPERTY_NAME
```
  - NO_MORE_ELEMENTS
```
public static final OCFErrorCode NO_MORE_ELEMENTS
```
  - NO_ITERATOR
```
public static final OCFErrorCode NO_ITERATOR
```
  - NULL_CLASSIFICATION_NAME
```
public static final OCFErrorCode NULL_CLASSIFICATION_NAME
```
  - NULL_TAG_NAME
```
public static final OCFErrorCode NULL_TAG_NAME
```
  - UNABLE_TO_REMOVE
```
public static final OCFErrorCode UNABLE_TO_REMOVE
```
  - INVALID_VIRTUAL_CONNECTION
```
public static final OCFErrorCode INVALID_VIRTUAL_CONNECTION
```
  - UNKNOWN_ENDPOINT
```
public static final OCFErrorCode UNKNOWN_ENDPOINT
```
  - PROPERTIES_NOT_AVAILABLE
```
public static final OCFErrorCode PROPERTIES_NOT_AVAILABLE
```
  - UNKNOWN_SCHEMA_TYPE
```
public static final OCFErrorCode UNKNOWN_SCHEMA_TYPE
```
  - CAUGHT_EXCEPTION
```
public static final OCFErrorCode CAUGHT_EXCEPTION
```
  - CAUGHT_EXCEPTION_WITHMSG
```
public static final OCFErrorCode CAUGHT_EXCEPTION_WITHMSG
```
  - NOT_IMPLEMENTED
```
public static final OCFErrorCode NOT_IMPLEMENTED
```
  - UNKNOWN_ERROR
```
public static final OCFErrorCode UNKNOWN_ERROR
```
  - INTERNAL_ERROR
```
public static final OCFErrorCode INTERNAL_ERROR
```
  - NULL_CONNECTOR_CLASS
```
public static final OCFErrorCode NULL_CONNECTOR_CLASS
```
  - UNKNOWN_CONNECTOR
```
public static final OCFErrorCode UNKNOWN_CONNECTOR
```
  - NOT_CONNECTOR
```
public static final OCFErrorCode NOT_CONNECTOR
```
  - INCOMPLETE_CONNECTOR
```
public static final OCFErrorCode INCOMPLETE_CONNECTOR
```
  - INVALID_CONNECTOR
```
public static final OCFErrorCode INVALID_CONNECTOR
```
  - NULL_CONNECTOR
```
public static final OCFErrorCode NULL_CONNECTOR
```
  - NOT_VIRTUAL_CONNECTOR
```
public static final OCFErrorCode NOT_VIRTUAL_CONNECTOR
```
- Method Detail
  - values
```
public static OCFErrorCode[] 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 (OCFErrorCode c : OCFErrorCode.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static OCFErrorCode 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
```
@Deprecated
public int getHTTPErrorCode()
```
    Deprecated.
    
    Return the HTTP error code for this exception.
    
    Returns:
    
    int
  - getErrorMessageId
```
@Deprecated
public String getErrorMessageId()
```
    Deprecated.
    
    Returns the unique identifier for the error message.
    
    Returns:
    
    errorMessageId
  - getFormattedErrorMessage
```
@Deprecated
public String getFormattedErrorMessage(String... params)
```
    Deprecated.
    
    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
```
@Deprecated
public String getSystemAction()
```
    Deprecated.
    
    Returns a description of the action taken by the system when the condition that caused this exception was detected.
    
    Returns:
    
    systemAction
  - getUserAction
```
@Deprecated
public String getUserAction()
```
    Deprecated.
    
    Returns instructions of how to resolve the issue reported in this exception.
    
    Returns:
    
    userAction
  - 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.

Enum OCFErrorCode

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

NULL_CONNECTION

UNNAMED_CONNECTION

NULL_CONNECTOR_TYPE

NULL_CONNECTOR_PROVIDER

UNKNOWN_CONNECTOR_PROVIDER

NOT_CONNECTOR_PROVIDER

INVALID_CONNECTOR_PROVIDER

NULL_ENDPOINT_IN_CONNECTION

MALFORMED_ENDPOINT

NULL_PROPERTY_NAME

INVALID_PROPERTY_NAMES

NULL_SECURED_PROPERTY_NAME

NO_MORE_ELEMENTS

NO_ITERATOR

NULL_CLASSIFICATION_NAME

NULL_TAG_NAME

UNABLE_TO_REMOVE

INVALID_VIRTUAL_CONNECTION

UNKNOWN_ENDPOINT

PROPERTIES_NOT_AVAILABLE

UNKNOWN_SCHEMA_TYPE

CAUGHT_EXCEPTION

CAUGHT_EXCEPTION_WITHMSG

NOT_IMPLEMENTED

UNKNOWN_ERROR

INTERNAL_ERROR

NULL_CONNECTOR_CLASS

UNKNOWN_CONNECTOR

NOT_CONNECTOR

INCOMPLETE_CONNECTOR

INVALID_CONNECTOR

NULL_CONNECTOR

NOT_VIRTUAL_CONNECTOR

Method Detail

values

valueOf

getHTTPErrorCode

getErrorMessageId

getFormattedErrorMessage

getSystemAction

getUserAction

getMessageDefinition

getMessageDefinition