org.omnifaces.persistence.model

Enum EnumMappingTable.DeleteAction

java.lang.Object

java.lang.Enum<EnumMappingTable.DeleteAction>

org.omnifaces.persistence.model.EnumMappingTable.DeleteAction

All Implemented Interfaces:

Serializable, Comparable<EnumMappingTable.DeleteAction>

Enclosing class:

EnumMappingTable

public static enum EnumMappingTable.DeleteAction
extends Enum<EnumMappingTable.DeleteAction>

Defines the types of the delete actions to be performed during the mapping.

Enum Constant Summary

Enum Constants

Enum Constant and Description
HARD_DELETE Indicates that the hard deletes will be performed, either to the database table rows, or to the java enum constants, basing on EnumMappingTable.mappingType() of this annotation.
NO_ACTION Indicates that the deletes will not be performed, neither to the database table, nor to the java enum.
SOFT_DELETE Indicates that the soft deletes will be performed to the database table rows.

Method Summary

Modifier and Type	Method and Description
static EnumMappingTable.DeleteAction	valueOf(String name) Returns the enum constant of this type with the specified name.
static EnumMappingTable.DeleteAction[]	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

NO_ACTION

public static final EnumMappingTable.DeleteAction NO_ACTION

Indicates that the deletes will not be performed, neither to the database table, nor to the java enum.

SOFT_DELETE

public static final EnumMappingTable.DeleteAction SOFT_DELETE

Indicates that the soft deletes will be performed to the database table rows. If EnumMappingTable.mappingType() of this annotation evaluates to EnumMappingTable.MappingType.TABLE then special column with the name specified in EnumMappingTable.deletedColumnName() of INT-compatible type must be holding the soft deleted state that isn't equals to 0 if the row is deleted. Enum constants will be hard deleted in this case nonetheless and the deleted enums will be persisted as soft deleted ones to the database table. If EnumMappingTable.mappingType() of this annotation evaluates to EnumMappingTable.MappingType.ENUM then an additional database table with the name equal to EnumMappingTable.tableName() with an added "_history" string will be created that will be holding all deleted instances of java enums if they are encountered in a corresponding table. This helps keep java enum and database table representations in line with each other and track historical values of java enum constants used previously.

HARD_DELETE

public static final EnumMappingTable.DeleteAction HARD_DELETE

Indicates that the hard deletes will be performed, either to the database table rows, or to the java enum constants, basing on EnumMappingTable.mappingType() of this annotation. This helps keep java enum and database table representations in line with each other without tracking historical values of java enum constants used previously. This is the default type.

Method Detail

values

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

Returns:

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

valueOf

public static EnumMappingTable.DeleteAction 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