Package com.bonitasoft.processbuilder.enums

Enum Class ConfigurationType

java.lang.Object

java.lang.Enum<ConfigurationType>

com.bonitasoft.processbuilder.enums.ConfigurationType

All Implemented Interfaces:

Serializable, Comparable<ConfigurationType>, Constable

public enum ConfigurationType
extends Enum<ConfigurationType>

Defines the valid types used to classify generic configuration entries (master data or lookup records) within the system.

This enumeration ensures type safety and restricts the classification of generic entries to a predefined set of metadata keys, crucial for maintaining consistency in system configuration objects managed by a process.

Since:

1.0

Author:

Bonitasoft

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
GENERIC	Represents the classification key for **Generic Configuration** definitions.
PROC_EXECUTION_CONNECTOR	Represents the classification key for **Process Execution Connector** definitions.
SMTP	Represents the classification key for **SMTP Configuration** definitions.
THEME	Represents the classification key for **Theme Configuration** definitions.

Method Summary

Modifier and Type	Method	Description
static Map<String,String>	getAllData()	Retrieves all configuration types as a read-only Map where the key is the technical key and the value is the description.
static List<String>	getAllKeysList()	Retrieves all technical keys as a read-only List of Strings.
String	getDescription()	Gets a brief business description of the action type.
String	getKey()	Gets the technical key of the flow action type, typically used for internal logic and data mapping.
static boolean	isValid(String input)	Checks if a given string corresponds to a valid enum constant, ignoring case and leading/trailing spaces.
static ConfigurationType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ConfigurationType[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

SMTP

public static final ConfigurationType SMTP

Represents the classification key for **SMTP Configuration** definitions. This type is used to identify and retrieve master data records that define the email server settings required for sending notifications (e.g., host, port, SSL/TLS, authentication credentials).

PROC_EXECUTION_CONNECTOR

public static final ConfigurationType PROC_EXECUTION_CONNECTOR

Represents the classification key for **Process Execution Connector** definitions. This type is used to identify and retrieve master data records that define the connector settings for process execution operations.

THEME

public static final ConfigurationType THEME

Represents the classification key for **Theme Configuration** definitions. This type is used to identify and retrieve master data records that define the visual appearance and branding of the application (e.g., colors, logos, fonts, styles).

GENERIC

public static final ConfigurationType GENERIC

Represents the classification key for **Generic Configuration** definitions.

This type is used to identify and retrieve master data records that define system-wide generic settings such as language preferences and application host URL. Generic configurations are stored in PBConfiguration and referenced by GenericType.

Method Details

values

public static ConfigurationType[] 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 ConfigurationType 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

getKey

public String getKey()

Gets the technical key of the flow action type, typically used for internal logic and data mapping.

Returns:

The technical key (lowercase).

getDescription

public String getDescription()

Gets a brief business description of the action type.

Returns:

The description for the user interface or documentation.

isValid

public static boolean isValid(String input)

Checks if a given string corresponds to a valid enum constant, ignoring case and leading/trailing spaces.

Parameters:

input - The string to validate.

Returns:

true if the string is a valid enum constant, false otherwise.

getAllData

public static Map<String,String> getAllData()

Retrieves all configuration types as a read-only Map where the key is the technical key and the value is the description.

Returns:

An unmodifiable map containing all configuration type data (Key -> Description).

getAllKeysList

public static List<String> getAllKeysList()

Retrieves all technical keys as a read-only List of Strings.

Returns:

A list containing all technical keys.