Package com.bonitasoft.processbuilder.enums

Enum Class BDMObjectType

java.lang.Object
java.lang.Enum<BDMObjectType>
com.bonitasoft.processbuilder.enums.BDMObjectType
All Implemented Interfaces:
Serializable, Comparable<BDMObjectType>, Constable
public enum BDMObjectType extends Enum<BDMObjectType>
Enumeration of BDM (Business Data Model) object types used in the Process Builder extension. This enum provides a centralized and type-safe way to reference BDM object names across the application.

Each enum constant represents a BDM entity and stores its string key and a description, which are used for: - Logging purposes - Generic search operations - Error messages - Database queries

Usage example:

 
 // Using the enum in ProcessUtils.searchBDM()
 PBProcess process = ProcessUtils.searchBDM(
     persistenceIdInput,
     searchFunction,
     BDMObjectType.PB_PROCESS.getKey()
 );
 
 // Getting the string representation and description
 String objectTypeKey = BDMObjectType.PB_PROCESS_INSTANCE.getKey();
 String objectTypeDescription = BDMObjectType.PB_PROCESS_INSTANCE.getDescription();
Since:
1.0
Author:
Bonitasoft

  • Enum Constant Details

    • PB_DATA_PROCESS_INSTANCE

      public static final BDMObjectType PB_DATA_PROCESS_INSTANCE
      Represents a PBDataProcessInstance BDM object. Used when searching or validating data process instances that contain business data.

    • PB_PROCESS_INSTANCE

      public static final BDMObjectType PB_PROCESS_INSTANCE
      Represents a PBProcessInstance BDM object. Used when searching or validating process instances and their execution context.

    • PB_STEP_PROCESS_INSTANCE

      public static final BDMObjectType PB_STEP_PROCESS_INSTANCE
      Represents a PBStepProcessInstance BDM object. Used when searching or validating step-level process instances.

    • PB_ACTION

      public static final BDMObjectType PB_ACTION
      Represents a PBAction BDM object. Used when searching or validating process actions and their configurations.

    • PB_ACTION_CONTENT

      public static final BDMObjectType PB_ACTION_CONTENT
      Represents a PBActionContent BDM object. Used when searching or validating the content and details associated with process actions.

    • PB_CATEGORY

      public static final BDMObjectType PB_CATEGORY
      Represents a PBCategory BDM object. Used when searching or validating process categories for organization and classification.

    • PB_ENTITY_TYPE

      public static final BDMObjectType PB_ENTITY_TYPE
      Represents a PBEntityType BDM object. Used when searching or validating entity type definitions and metadata.

    • PB_FILES

      public static final BDMObjectType PB_FILES
      Represents a PBFiles BDM object. Used when searching or validating file storage and document management data.

    • PB_GENERIC_ENTRY

      public static final BDMObjectType PB_GENERIC_ENTRY
      Represents a PBGenericEntry BDM object. Used when searching or validating generic entry data structures.

    • PB_PROCESS

      public static final BDMObjectType PB_PROCESS
      Represents a PBProcess BDM object. Used when searching or validating process definitions and configurations.

    • PB_RUNNING_INSTANCE

      public static final BDMObjectType PB_RUNNING_INSTANCE
      Represents a PBRunningInstance BDM object. Used when searching or validating currently active process instances.

    • PB_SMTP

      public static final BDMObjectType PB_SMTP
      Represents a PBSmtp BDM object. Used when searching or validating SMTP email configuration data.

    • PB_STEPS

      public static final BDMObjectType PB_STEPS
      Represents a PBSteps BDM object. Used when searching or validating process step definitions and sequences.

    • PB_USER_LIST

      public static final BDMObjectType PB_USER_LIST
      Represents a PBUserList BDM object. Used when searching or validating user list data and assignments.

  • Method Details

    • values

      public static BDMObjectType[] 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 BDMObjectType 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 BDM object type.
      Returns:
      The technical key (e.g., "PBAction").

    • getDescription

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

    • toString

      public String toString()
      Returns a string representation of this enum constant. Useful for debugging and logging purposes.
      Overrides:
      toString in class Enum<BDMObjectType>
      Returns:
      A string containing the enum name, key, and description.

    • getAllData

      public static Map<String,String> getAllData()
      Retrieves all BDM object types as a read-only Map where the key is the technical key and the value is the description.
      Returns:
      A map containing all BDM object type 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.

    • fromKey

      public static BDMObjectType fromKey(String key)
      Retrieves a BDMObjectType enum constant by its technical key. This method is useful for deserializing or converting string keys back to enum constants.

      Usage example:

       
 BDMObjectType type = BDMObjectType.fromKey("PBProcess");
 // Returns BDMObjectType.PB_PROCESS
      Parameters:
      key - The technical key of the BDM object type (e.g., "PBProcess").
      Returns:
      The corresponding BDMObjectType enum constant.
      Throws:
      IllegalArgumentException - if no enum constant with the specified key is found.