TexViewErrorCode (tex-view-api 2.8 API)

java.lang.Object
- java.lang.Enum<TexViewErrorCode>
- - org.odpi.openmetadata.viewservices.tex.api.ffdc.TexViewErrorCode

All Implemented Interfaces:

Serializable, Comparable<TexViewErrorCode>, ExceptionMessageSet
```
public enum TexViewErrorCode
extends Enum<TexViewErrorCode>
implements ExceptionMessageSet
```
The TexViewErrorCode is used to define first failure data capture (FFDC) for errors that occur within the OMVS It is used in conjunction with all OMVS 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
  - 501: not implemented
  - 503: Service not available
  - 400: invalid parameters
  - 401: unauthorized
  - 404: not found
  - 405: method not allowed
  - 409: data conflict errors, for example an item is 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
`INVALID_CONFIG_PROPERTY`
`INVALID_PARAMETER`
`PLATFORM_NOT_AVAILABLE`
`REPOSITORY_ERROR`
`REPOSITORY_NOT_AVAILABLE`
`SERVICE_NOT_INITIALIZED`
`TYPE_SYSTEM_CLASSIFICATION_DEF_MISSING`
`TYPE_SYSTEM_CLASSIFICATION_SUPERTYPE_MISSING`
`TYPE_SYSTEM_CLASSIFICATION_SUPERTYPE_NAME_MISSING`
`TYPE_SYSTEM_CLASSIFICATION_VALID_ENTITY_MISSING`
`TYPE_SYSTEM_CLASSIFICATION_VALID_ENTITY_NAME_MISSING`
`TYPE_SYSTEM_ENTITY_DEF_MISSING`
`TYPE_SYSTEM_ENTITY_SUPERTYPE_MISSING`
`TYPE_SYSTEM_ENTITY_SUPERTYPE_NAME_MISSING`
`TYPE_SYSTEM_RELATIONSHIP_DEF_MISSING`
`TYPE_SYSTEM_RELATIONSHIP_END_DEF_MISSING`
`USER_NOT_AUTHORIZED`
`VIEW_SERVICE_NULL_PLATFORM_NAME`
`VIEW_SERVICE_NULL_SERVER_NAME`
`VIEW_SERVICE_REQUEST_BODY_MISSING`
`VIEW_SERVICE_UNKNOWN_SERVER_NAME`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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.
`String`	`toString()` toString() JSON-style
`static TexViewErrorCode`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static TexViewErrorCode[]`	`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, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - SERVICE_NOT_INITIALIZED
```
public static final TexViewErrorCode SERVICE_NOT_INITIALIZED
```
  - INVALID_CONFIG_PROPERTY
```
public static final TexViewErrorCode INVALID_CONFIG_PROPERTY
```
  - VIEW_SERVICE_NULL_PLATFORM_NAME
```
public static final TexViewErrorCode VIEW_SERVICE_NULL_PLATFORM_NAME
```
  - VIEW_SERVICE_NULL_SERVER_NAME
```
public static final TexViewErrorCode VIEW_SERVICE_NULL_SERVER_NAME
```
  - VIEW_SERVICE_UNKNOWN_SERVER_NAME
```
public static final TexViewErrorCode VIEW_SERVICE_UNKNOWN_SERVER_NAME
```
  - USER_NOT_AUTHORIZED
```
public static final TexViewErrorCode USER_NOT_AUTHORIZED
```
  - REPOSITORY_NOT_AVAILABLE
```
public static final TexViewErrorCode REPOSITORY_NOT_AVAILABLE
```
  - PLATFORM_NOT_AVAILABLE
```
public static final TexViewErrorCode PLATFORM_NOT_AVAILABLE
```
  - REPOSITORY_ERROR
```
public static final TexViewErrorCode REPOSITORY_ERROR
```
  - INVALID_PARAMETER
```
public static final TexViewErrorCode INVALID_PARAMETER
```
  - VIEW_SERVICE_REQUEST_BODY_MISSING
```
public static final TexViewErrorCode VIEW_SERVICE_REQUEST_BODY_MISSING
```
  - TYPE_SYSTEM_ENTITY_DEF_MISSING
```
public static final TexViewErrorCode TYPE_SYSTEM_ENTITY_DEF_MISSING
```
  - TYPE_SYSTEM_ENTITY_SUPERTYPE_NAME_MISSING
```
public static final TexViewErrorCode TYPE_SYSTEM_ENTITY_SUPERTYPE_NAME_MISSING
```
  - TYPE_SYSTEM_ENTITY_SUPERTYPE_MISSING
```
public static final TexViewErrorCode TYPE_SYSTEM_ENTITY_SUPERTYPE_MISSING
```
  - TYPE_SYSTEM_RELATIONSHIP_DEF_MISSING
```
public static final TexViewErrorCode TYPE_SYSTEM_RELATIONSHIP_DEF_MISSING
```
  - TYPE_SYSTEM_RELATIONSHIP_END_DEF_MISSING
```
public static final TexViewErrorCode TYPE_SYSTEM_RELATIONSHIP_END_DEF_MISSING
```
  - TYPE_SYSTEM_CLASSIFICATION_DEF_MISSING
```
public static final TexViewErrorCode TYPE_SYSTEM_CLASSIFICATION_DEF_MISSING
```
  - TYPE_SYSTEM_CLASSIFICATION_VALID_ENTITY_NAME_MISSING
```
public static final TexViewErrorCode TYPE_SYSTEM_CLASSIFICATION_VALID_ENTITY_NAME_MISSING
```
  - TYPE_SYSTEM_CLASSIFICATION_VALID_ENTITY_MISSING
```
public static final TexViewErrorCode TYPE_SYSTEM_CLASSIFICATION_VALID_ENTITY_MISSING
```
  - TYPE_SYSTEM_CLASSIFICATION_SUPERTYPE_NAME_MISSING
```
public static final TexViewErrorCode TYPE_SYSTEM_CLASSIFICATION_SUPERTYPE_NAME_MISSING
```
  - TYPE_SYSTEM_CLASSIFICATION_SUPERTYPE_MISSING
```
public static final TexViewErrorCode TYPE_SYSTEM_CLASSIFICATION_SUPERTYPE_MISSING
```
- Method Detail
  - values
```
public static TexViewErrorCode[] 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 (TexViewErrorCode c : TexViewErrorCode.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static TexViewErrorCode 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.
  - toString
```
public String toString()
```
    toString() JSON-style
    
    Overrides:
    
    toString in class Enum<TexViewErrorCode>
    
    Returns:
    
    string description

Enum TexViewErrorCode

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

SERVICE_NOT_INITIALIZED

INVALID_CONFIG_PROPERTY

VIEW_SERVICE_NULL_PLATFORM_NAME

VIEW_SERVICE_NULL_SERVER_NAME

VIEW_SERVICE_UNKNOWN_SERVER_NAME

USER_NOT_AUTHORIZED

REPOSITORY_NOT_AVAILABLE

PLATFORM_NOT_AVAILABLE

REPOSITORY_ERROR

INVALID_PARAMETER

VIEW_SERVICE_REQUEST_BODY_MISSING

TYPE_SYSTEM_ENTITY_DEF_MISSING

TYPE_SYSTEM_ENTITY_SUPERTYPE_NAME_MISSING

TYPE_SYSTEM_ENTITY_SUPERTYPE_MISSING

TYPE_SYSTEM_RELATIONSHIP_DEF_MISSING

TYPE_SYSTEM_RELATIONSHIP_END_DEF_MISSING

TYPE_SYSTEM_CLASSIFICATION_DEF_MISSING

TYPE_SYSTEM_CLASSIFICATION_VALID_ENTITY_NAME_MISSING

TYPE_SYSTEM_CLASSIFICATION_VALID_ENTITY_MISSING

TYPE_SYSTEM_CLASSIFICATION_SUPERTYPE_NAME_MISSING

TYPE_SYSTEM_CLASSIFICATION_SUPERTYPE_MISSING

Method Detail

values

valueOf

getMessageDefinition

getMessageDefinition

toString