Package com.bonitasoft.processbuilder.enums

Enum Class ObjectsManagementOptionType

java.lang.Object
java.lang.Enum<ObjectsManagementOptionType>
com.bonitasoft.processbuilder.enums.ObjectsManagementOptionType
All Implemented Interfaces:
Serializable, Comparable<ObjectsManagementOptionType>, Constable
public enum ObjectsManagementOptionType extends Enum<ObjectsManagementOptionType>
Defines the valid option types for the object management process.

This enumeration helps to ensure type safety and code readability by restricting the object type to a predefined set of values, specifically for system configuration objects managed by a process.

Since:
1.0
Author:
Bonitasoft

  • Enum Constant Details

    • CATEGORY

      public static final ObjectsManagementOptionType CATEGORY
      Represents a category object used for classification or grouping.

    • CONFIGURATION

      public static final ObjectsManagementOptionType CONFIGURATION
      Represents a system configuration object containing key-value settings.

    • GENERIC_ENTRY

      public static final ObjectsManagementOptionType GENERIC_ENTRY
      Represents a **generic entry** or record, typically originating from a master data table. This object holds the actual data values (e.g., records from a "lookup" table).

    • ENTITY_TYPE

      public static final ObjectsManagementOptionType ENTITY_TYPE
      Represents the **entity type** or classification identifier for a record. This field is embedded within a GENERIC_ENTRY object to specify the kind of master data or lookup object the entry represents, allowing a single table structure (GENERIC_ENTRY) to contain multiple logical object types.

    • AI_PROVIDER

      public static final ObjectsManagementOptionType AI_PROVIDER
      Represents an AI provider configuration for integrating external AI/LLM services. This object holds connection details, model selection, and credential information for AI providers such as OpenAI, Anthropic, or Azure OpenAI.

  • Method Details

    • values

      public static ObjectsManagementOptionType[] 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 ObjectsManagementOptionType 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 optionTypeInput)
      Checks if a given string corresponds to a valid enum constant, ignoring case and leading/trailing spaces.
      Parameters:
      optionTypeInput - The string to validate (e.g., "category", " SMTP ").
      Returns:
      true if the string is a valid enum constant, false otherwise.

    • isJsonValidForType

      public static boolean isJsonValidForType(String actionType, String optionType, Object jsonInput)
      Validates a JSON input against the specific schema associated with the provided object management type.

      This method delegates the validation call to the centralized JsonSchemaValidator utility.

      Parameters:
      actionType - The action being performed (e.g., "DELETE", "INSERT", "UPDATE").
      optionType - The string instance of the object type (e.g., "CATEGORY", "SMTP").
      jsonInput - The JSON content to validate, expected as a Map/Object from the process context.
      Returns:
      true if validation is successful and the schema check passes, 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.