Package org.camunda.bpm.engine.authorization

Enum HistoricProcessInstancePermissions

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      ALL
      Indicates that all interactions are permitted.
      NONE
      The none permission means 'no action', 'doing nothing'.
      READ
      Indicates that READ interactions are permitted.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected int id  
      protected java.lang.String name  
      protected static Resource[] RESOURCES  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getName()
      returns the name of the permission, ie.
      Resource[] getTypes()
      returns the resource types which are allowed for this permission
      int getValue()
      returns the unique numeric value of the permission.
      static HistoricProcessInstancePermissions valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static HistoricProcessInstancePermissions[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • 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 also the ALL permission is revoked, because the user is not authorized to execute all actions anymore.

    • Field Detail

      • RESOURCES

        protected static final Resource[] RESOURCES

      • name

        protected java.lang.String name

      • id

        protected int id

    • Method Detail

      • values

        public static HistoricProcessInstancePermissions[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (HistoricProcessInstancePermissions c : HistoricProcessInstancePermissions.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static HistoricProcessInstancePermissions valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null

      • getName

        public java.lang.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