Package org.odpi.openmetadata.accessservices.securityofficer.api.ffdc

Enum Class SecurityOfficerErrorCode

java.lang.Object

java.lang.Enum<SecurityOfficerErrorCode>

org.odpi.openmetadata.accessservices.securityofficer.api.ffdc.SecurityOfficerErrorCode

All Implemented Interfaces:

Serializable, Comparable<SecurityOfficerErrorCode>, Constable, org.odpi.openmetadata.frameworks.auditlog.messagesets.ExceptionMessageSet

public enum SecurityOfficerErrorCode
extends Enum<SecurityOfficerErrorCode>
implements org.odpi.openmetadata.frameworks.auditlog.messagesets.ExceptionMessageSet

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
NO_METADATA_COLLECTION
NULL_LISTENER
NULL_TOPIC_CONNECTOR
OMRS_NOT_AVAILABLE
OMRS_NOT_INITIALIZED
SERVICE_NOT_INITIALIZED
UNABLE_TO_SEND_EVENT
UNEXPECTED_INITIALIZATION_EXCEPTION
UNEXPECTED_REPOSITORY_EXCEPTION

Method Summary

Modifier and Type	Method	Description
org.odpi.openmetadata.frameworks.auditlog.messagesets.ExceptionMessageDefinition	getMessageDefinition()	Retrieve a message definition object for an exception.
org.odpi.openmetadata.frameworks.auditlog.messagesets.ExceptionMessageDefinition	getMessageDefinition(String... params)	Retrieve a message definition object for an exception.
String	toString()	toString() JSON-style
static SecurityOfficerErrorCode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SecurityOfficerErrorCode[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

OMRS_NOT_INITIALIZED

public static final SecurityOfficerErrorCode OMRS_NOT_INITIALIZED

OMRS_NOT_AVAILABLE

public static final SecurityOfficerErrorCode OMRS_NOT_AVAILABLE

NO_METADATA_COLLECTION

public static final SecurityOfficerErrorCode NO_METADATA_COLLECTION

SERVICE_NOT_INITIALIZED

public static final SecurityOfficerErrorCode SERVICE_NOT_INITIALIZED

NULL_TOPIC_CONNECTOR

public static final SecurityOfficerErrorCode NULL_TOPIC_CONNECTOR

NULL_LISTENER

public static final SecurityOfficerErrorCode NULL_LISTENER

UNABLE_TO_SEND_EVENT

public static final SecurityOfficerErrorCode UNABLE_TO_SEND_EVENT

UNEXPECTED_INITIALIZATION_EXCEPTION

public static final SecurityOfficerErrorCode UNEXPECTED_INITIALIZATION_EXCEPTION

UNEXPECTED_REPOSITORY_EXCEPTION

public static final SecurityOfficerErrorCode UNEXPECTED_REPOSITORY_EXCEPTION

Method Details

values

public static SecurityOfficerErrorCode[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static SecurityOfficerErrorCode valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

getMessageDefinition

public org.odpi.openmetadata.frameworks.auditlog.messagesets.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 org.odpi.openmetadata.frameworks.auditlog.messagesets.ExceptionMessageSet

Returns:

message definition object.

getMessageDefinition

public org.odpi.openmetadata.frameworks.auditlog.messagesets.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 org.odpi.openmetadata.frameworks.auditlog.messagesets.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<SecurityOfficerErrorCode>

Returns:

string description