Package com.bonitasoft.processbuilder.enums

Enum Class RecipientsType

java.lang.Object
java.lang.Enum<RecipientsType>
com.bonitasoft.processbuilder.enums.RecipientsType
All Implemented Interfaces:
Serializable, Comparable<RecipientsType>, Constable
public enum RecipientsType extends Enum<RecipientsType>
Defines the valid recipient types for notification actions in process workflows. This enumeration specifies how recipients are determined for email or notification actions.

Each type represents a different strategy for resolving the target recipients:

  • MEMBERSHIP - Recipients based on organization membership
  • USERS - Specific user accounts
  • STEP_USERS - Users who executed a specific step
  • STEP_MANAGERS - Managers of users who executed a specific step
  • SPECIFIC - Explicitly specified email addresses
Since:
1.0
Author:
Bonitasoft

  • Enum Constant Details

    • MEMBERSHIP

      public static final RecipientsType MEMBERSHIP
      Recipients determined by organizational membership (group, role, or membership).

    • USERS

      public static final RecipientsType USERS
      Recipients specified as a list of user identifiers.

    • STEP_USERS

      public static final RecipientsType STEP_USERS
      Recipients resolved from users who executed a specific process step.

    • STEP_MANAGERS

      public static final RecipientsType STEP_MANAGERS
      Recipients resolved as the managers of users who executed a specific step.

    • SPECIFIC

      public static final RecipientsType SPECIFIC
      Recipients specified as explicit email addresses.

  • Method Details

    • values

      public static RecipientsType[] 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 RecipientsType 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 recipient type.
      Returns:
      The recipient type key (e.g., "step_users", "membership").

    • getDescription

      public String getDescription()
      Returns the description of this recipient 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.

    • fromKey

      public static RecipientsType fromKey(String key)
      Finds a RecipientsType by its key value.
      Parameters:
      key - The key to search for (e.g., "step_users").
      Returns:
      The matching RecipientsType, or null if not found.

    • getAllData

      public static Map<String,String> getAllData()
      Retrieves all recipient 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 recipient 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 recipient type keys.