CommunityProfileErrorCode (Community Profile OMAS API 2.8 API)

java.lang.Object
- java.lang.Enum<CommunityProfileErrorCode>
- - org.odpi.openmetadata.accessservices.communityprofile.ffdc.CommunityProfileErrorCode

All Implemented Interfaces:

Serializable, Comparable<CommunityProfileErrorCode>, ExceptionMessageSet
```
public enum CommunityProfileErrorCode
extends Enum<CommunityProfileErrorCode>
implements ExceptionMessageSet
```
The CommunityProfileErrorCode is used to define first failure data capture (FFDC) for errors that occur when working with the Community Profile 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 a consumer should correct the error

Enum Constant Summary

Enum Constants
Enum Constant and Description
`NO_IDENTITY_FOR_PROFILE`
`NO_OTHER_IDENTITY`
`OMRS_NOT_INITIALIZED`
`PARSE_EVENT_ERROR`
`QUALIFIED_NAME_NOT_UNIQUE`
`UNABLE_TO_CREATE_CONTRIBUTION_RECORD`
`UNABLE_TO_CREATE_USER_IDENTITY`
`UNKNOWN_IDENTITY`

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()` JSON-style toString
`static CommunityProfileErrorCode`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static CommunityProfileErrorCode[]`	`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
  - NO_OTHER_IDENTITY
```
public static final CommunityProfileErrorCode NO_OTHER_IDENTITY
```
  - QUALIFIED_NAME_NOT_UNIQUE
```
public static final CommunityProfileErrorCode QUALIFIED_NAME_NOT_UNIQUE
```
  - UNKNOWN_IDENTITY
```
public static final CommunityProfileErrorCode UNKNOWN_IDENTITY
```
  - OMRS_NOT_INITIALIZED
```
public static final CommunityProfileErrorCode OMRS_NOT_INITIALIZED
```
  - UNABLE_TO_CREATE_USER_IDENTITY
```
public static final CommunityProfileErrorCode UNABLE_TO_CREATE_USER_IDENTITY
```
  - UNABLE_TO_CREATE_CONTRIBUTION_RECORD
```
public static final CommunityProfileErrorCode UNABLE_TO_CREATE_CONTRIBUTION_RECORD
```
  - NO_IDENTITY_FOR_PROFILE
```
public static final CommunityProfileErrorCode NO_IDENTITY_FOR_PROFILE
```
  - PARSE_EVENT_ERROR
```
public static final CommunityProfileErrorCode PARSE_EVENT_ERROR
```
- Method Detail
  - values
```
public static CommunityProfileErrorCode[] 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 (CommunityProfileErrorCode c : CommunityProfileErrorCode.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static CommunityProfileErrorCode 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()
```
    JSON-style toString
    
    Overrides:
    
    toString in class Enum<CommunityProfileErrorCode>
    
    Returns:
    
    string of property names and values for this enum

Enum CommunityProfileErrorCode

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

NO_OTHER_IDENTITY

QUALIFIED_NAME_NOT_UNIQUE

UNKNOWN_IDENTITY

OMRS_NOT_INITIALIZED

UNABLE_TO_CREATE_USER_IDENTITY

UNABLE_TO_CREATE_CONTRIBUTION_RECORD

NO_IDENTITY_FOR_PROFILE

PARSE_EVENT_ERROR

Method Detail

values

valueOf

getMessageDefinition

getMessageDefinition

toString