Package com.bonitasoft.processbuilder.records

Record Class UserList

java.lang.Object
java.lang.Record
com.bonitasoft.processbuilder.records.UserList
Record Components:
persistenceId - The unique identifier for this user list entry.
canLaunchProcess - A flag indicating if the user/membership can launch the process.
refMemberShip - The reference name of the membership (e.g., a role or group name).
memberShipKey - The unique key identifying the type of membership (e.g., "ROLE", "GROUP", "USER").
groupId - The persistence ID of the associated group, if applicable.
roleId - The persistence ID of the associated role, if applicable.
userId - The persistence ID of the associated user, if applicable.
pBProcessPersistenceId - The persistence ID of the process definition this list belongs to.
public record UserList(Long persistenceId, Boolean canLaunchProcess, String refMemberShip, String memberShipKey, Long groupId, Long roleId, Long userId, Long pBProcessPersistenceId) extends Record
Record representing a minimal set of user and membership data defined for a **process definition**.

This record is used to store the specific users and memberships associated with a process to facilitate efficient passing of actor filter data without including the complete process user list (`PBUserList`) object.

  • Constructor Details

    • UserList

      public UserList(Long persistenceId, Boolean canLaunchProcess, String refMemberShip, String memberShipKey, Long groupId, Long roleId, Long userId, Long pBProcessPersistenceId)
      Compact constructor to perform validation or canonicalization, if needed. Currently, it serves as the default constructor provided by the record.
      Parameters:
      persistenceId - The unique identifier for this user list entry.
      canLaunchProcess - A flag indicating if the user/membership can launch the process.
      refMemberShip - The reference name of the membership (e.g., a role or group name).
      memberShipKey - The unique key identifying the type of membership (e.g., "ROLE", "GROUP", "USER").
      groupId - The persistence ID of the associated group, if applicable.
      roleId - The persistence ID of the associated role, if applicable.
      userId - The persistence ID of the associated user, if applicable.
      pBProcessPersistenceId - The persistence ID of the process definition this list belongs to.

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • persistenceId

      public Long persistenceId()
      Returns the value of the persistenceId record component.
      Returns:
      the value of the persistenceId record component

    • canLaunchProcess

      public Boolean canLaunchProcess()
      Returns the value of the canLaunchProcess record component.
      Returns:
      the value of the canLaunchProcess record component

    • refMemberShip

      public String refMemberShip()
      Returns the value of the refMemberShip record component.
      Returns:
      the value of the refMemberShip record component

    • memberShipKey

      public String memberShipKey()
      Returns the value of the memberShipKey record component.
      Returns:
      the value of the memberShipKey record component

    • groupId

      public Long groupId()
      Returns the value of the groupId record component.
      Returns:
      the value of the groupId record component

    • roleId

      public Long roleId()
      Returns the value of the roleId record component.
      Returns:
      the value of the roleId record component

    • userId

      public Long userId()
      Returns the value of the userId record component.
      Returns:
      the value of the userId record component

    • pBProcessPersistenceId

      public Long pBProcessPersistenceId()
      Returns the value of the pBProcessPersistenceId record component.
      Returns:
      the value of the pBProcessPersistenceId record component