Package com.bonitasoft.processbuilder.enums

Enum Class ActionParameterType

java.lang.Object
java.lang.Enum<ActionParameterType>
com.bonitasoft.processbuilder.enums.ActionParameterType
All Implemented Interfaces:
Serializable, Comparable<ActionParameterType>, Constable
public enum ActionParameterType extends Enum<ActionParameterType>
Defines the valid parameter keys for ActionContent.parameters configuration. This enumeration provides a type-safe way to reference action parameters used in process step actions, such as notifications, redirections, and assignments.
Since:
1.0
Author:
Bonitasoft

  • Enum Constant Details

    • NAME

      public static final ActionParameterType NAME
      The name identifier for the action parameter.

    • TARGET_STEP

      public static final ActionParameterType TARGET_STEP
      The target step reference for redirection or flow actions.

    • RECIPIENTS

      public static final ActionParameterType RECIPIENTS
      The recipients configuration object for notification actions.

    • RECIPIENTS_TYPE

      public static final ActionParameterType RECIPIENTS_TYPE
      The type of recipients selection (e.g., static, dynamic, step-based).

    • RECIPIENTS_STEP_ID

      public static final ActionParameterType RECIPIENTS_STEP_ID
      The step identifier used to resolve dynamic recipients.

    • MESSAGE

      public static final ActionParameterType MESSAGE
      The message body content for notification actions.

    • SUBJECT

      public static final ActionParameterType SUBJECT
      The subject line for email notification actions.

    • RECIPIENTS_SPECIFIC_EMAILS

      public static final ActionParameterType RECIPIENTS_SPECIFIC_EMAILS
      The list of specific email addresses for notification recipients.

    • RECIPIENTS_USER_IDS

      public static final ActionParameterType RECIPIENTS_USER_IDS
      The list of user identifiers for notification recipients.

    • RECIPIENTS_MEMBERSHIP_IDS

      public static final ActionParameterType RECIPIENTS_MEMBERSHIP_IDS
      The list of membership identifiers for notification recipients.

    • ENABLED

      public static final ActionParameterType ENABLED
      The enabled flag for action parameters.

      Used to indicate whether an action or feature is enabled or disabled.

    • OBJECT

      public static final ActionParameterType OBJECT
      The object parameter for action configuration.

      Used to reference a generic object or entity associated with the action.

    • DAYS

      public static final ActionParameterType DAYS
      The number of days parameter for delay or scheduling actions.

      Used to specify a duration in days for time-based actions.

    • HOURS

      public static final ActionParameterType HOURS
      The number of hours parameter for delay or scheduling actions.

      Used to specify a duration in hours for time-based actions.

  • Method Details

    • values

      public static ActionParameterType[] 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 ActionParameterType 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 action parameter.
      Returns:
      The parameter key (e.g., "targetStep", "recipients.type").

    • getDescription

      public String getDescription()
      Returns the description of this action parameter.
      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 action parameters as a read-only Map where the key is the technical key and the value is the description.
      Returns:
      An unmodifiable map containing all parameter 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 parameter keys.