Enum Class HistoricProcessInstancePermissions

java.lang.Object
java.lang.Enum<HistoricProcessInstancePermissions>
org.camunda.bpm.engine.authorization.HistoricProcessInstancePermissions
All Implemented Interfaces:
Serializable, Comparable<HistoricProcessInstancePermissions>, Constable, Permission

public enum HistoricProcessInstancePermissions extends Enum<HistoricProcessInstancePermissions> implements Permission
The set of built-in Permissions for Historic Process Instance in Camunda Platform.
  • Enum Constant Details

    • NONE

      public static final HistoricProcessInstancePermissions NONE
      The none permission means 'no action', 'doing nothing'. It does not mean that no permissions are granted.
    • ALL

      public static final HistoricProcessInstancePermissions ALL
      Indicates that all interactions are permitted. If ALL is revoked it means that the user is not permitted to do everything, which means that at least one permission is revoked. This does not implicate that all individual permissions are revoked. Example: If the UPDATE permission is revoked then the ALL permission is revoked as well, because the user is not authorized to execute all actions anymore.
    • READ

      public static final HistoricProcessInstancePermissions READ
      Indicates that READ interactions are permitted.
  • Field Details

    • RESOURCES

      protected static final Resource[] RESOURCES
    • name

      protected String name
    • id

      protected int id
  • Method Details

    • values

      public static HistoricProcessInstancePermissions[] 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 HistoricProcessInstancePermissions 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
    • getName

      public String getName()
      Description copied from interface: Permission
      returns the name of the permission, ie. 'UPDATE'
      Specified by:
      getName in interface Permission
    • getValue

      public int getValue()
      Description copied from interface: Permission
      returns the unique numeric value of the permission. Must be a power of 2. ie 2^0, 2^1, 2^2, 2^3, 2^4 ...
      Specified by:
      getValue in interface Permission
    • getTypes

      public Resource[] getTypes()
      Description copied from interface: Permission
      returns the resource types which are allowed for this permission
      Specified by:
      getTypes in interface Permission