Package com.bonitasoft.processbuilder.enums

Enum Class GenericEntryType

java.lang.Object
java.lang.Enum<GenericEntryType>
com.bonitasoft.processbuilder.enums.GenericEntryType
All Implemented Interfaces:
Serializable, Comparable<GenericEntryType>, Constable
public enum GenericEntryType extends Enum<GenericEntryType>
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

  • Enum Constant Details

    • PROCESS_STORAGE

      public static final GenericEntryType PROCESS_STORAGE
      Represents the classification key for **Process Storage** definitions. This type is used to identify and retrieve master data records that define where process documents and files should be persisted (e.g., local server, BDM database, with retention or deletion).

    • CRITICALITY

      public static final GenericEntryType CRITICALITY
      Represents the classification key for **Process Criticality** definitions. This type is used to identify and retrieve master data records that define the business impact or priority level of a process (e.g., Low, Medium, High).

    • DOCUMENTS_FOLDER

      public static final GenericEntryType DOCUMENTS_FOLDER
      Represents the classification key for **Documents Folder** definitions. This type is used to identify and retrieve master data records that define the directory paths where process documents should be stored. Multiple folder configurations can be defined and selected per PBProcess.

    • REST_APIS

      public static final GenericEntryType REST_APIS
      Represents the classification key for **REST APIs** definitions. This type is used to identify and retrieve master data records that define the configuration for REST API services that can be executed.

    • REST_API_TEMPLATES

      public static final GenericEntryType REST_API_TEMPLATES
      Represents the classification key for **REST API Templates** definitions. This type is used to identify and retrieve master data records that define the available REST API templates/schemas that can be configured for use.

  • Method Details

    • values

      public static GenericEntryType[] 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 GenericEntryType 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 process instance states as a read-only Map where the key is the technical key and the value is the description.
      Returns:
      A map containing all process state 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.