Package com.bonitasoft.processbuilder.enums

Enum Class FormContentType

java.lang.Object
java.lang.Enum<FormContentType>
com.bonitasoft.processbuilder.enums.FormContentType
All Implemented Interfaces:
Serializable, Comparable<FormContentType>, Constable
public enum FormContentType extends Enum<FormContentType>
Defines the valid content types for the formContentType field in PBFormActionContent.

This enumeration provides a type-safe way to reference the different content types that can be associated with form actions, such as notifications, delays, alerts, and messages.

Since:
1.0
Author:
Bonitasoft

  • Enum Constant Details

    • NOTIFICATIONS

      public static final FormContentType NOTIFICATIONS
      Content type for notification-related form actions.

      Used when the form action involves sending notifications to users or groups.

    • DELAY

      public static final FormContentType DELAY
      Content type for delay-related form actions.

      Used when the form action involves scheduling or delaying an operation.

    • ALERT

      public static final FormContentType ALERT
      Content type for alert-related form actions.

      Used when the form action involves displaying alerts or warnings to users.

    • MESSAGE

      public static final FormContentType MESSAGE
      Content type for message-related form actions.

      Used when the form action involves sending or displaying messages.

  • Method Details

    • values

      public static FormContentType[] 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 FormContentType 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()
      Returns the unique string key associated with this content type.
      Returns:
      The content type key (e.g., "notifications", "delay").

    • getDescription

      public String getDescription()
      Returns the description of this content type.
      Returns:
      The human-readable description.

    • 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 name, false otherwise.

    • getAllData

      public static Map<String,String> getAllData()
      Retrieves all form content 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 content type data (Key -> Description).

    • getAllKeysList

      public static List<String> getAllKeysList()
      Retrieves all technical keys as a read-only List of Strings.
      Returns:
      An unmodifiable list containing all content type keys.