Package de.xima.fc.audit

Enum AuditErrorType

java.lang.Object

java.lang.Enum<AuditErrorType>

de.xima.fc.audit.AuditErrorType

All Implemented Interfaces:

Serializable, Comparable<AuditErrorType>

public enum AuditErrorType
extends Enum<AuditErrorType>
implements Serializable

Error types for the audit domain, carried by FcAuditException. Invalid arguments (a null entry or user, a blank message) are not modelled here; they are signalled with an IllegalArgumentException. This enum covers only genuine domain failures.

Each constant carries a stable code and an i18n message key a renderer resolves against its own resource bundle to present the error.

Since:

8.5.6

Author:

Norman Lorenz

Enum Constant Summary

Enum Constants

Enum Constant	Description
NOT_FOUND	The referenced entity (tenant, form version or form record) does not exist.
PERSISTENCE_ERROR	A persistence-layer failure occurred while writing the protocol entry.

Method Summary

Modifier and Type	Method	Description
String	getCode()	Stable, machine-readable error code (also useful for support and logs).
String	getMessageKey()	The i18n message key a renderer resolves against its own resource bundle to present this error to the user.
static AuditErrorType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static AuditErrorType[]	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

NOT_FOUND

public static final AuditErrorType NOT_FOUND

The referenced entity (tenant, form version or form record) does not exist.

PERSISTENCE_ERROR

public static final AuditErrorType PERSISTENCE_ERROR

A persistence-layer failure occurred while writing the protocol entry.

Method Detail

values

public static AuditErrorType[] 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 (AuditErrorType c : AuditErrorType.values())
    System.out.println(c);

Returns:

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

valueOf

public static AuditErrorType 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

getCode

public String getCode()

Stable, machine-readable error code (also useful for support and logs).

getMessageKey

public String getMessageKey()

The i18n message key a renderer resolves against its own resource bundle to present this error to the user. Part of the error contract, so all renderers show a consistent, localized message.