BatchPermissions (Camunda Platform Javadocs 7.15.19-ee)

java.lang.Object
- java.lang.Enum<BatchPermissions>
- - org.camunda.bpm.engine.authorization.BatchPermissions

All Implemented Interfaces:

Serializable, Comparable<BatchPermissions>, Permission
```
public enum BatchPermissions
extends Enum<BatchPermissions>
implements Permission
```
The set of built-in Permissions for Batch operations in Camunda Platform.

Author:

Yana Vasileva

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ALL` Indicates that all interactions are permitted.
`CREATE` Indicates that CREATE interactions are permitted.
`CREATE_BATCH_DELETE_DECISION_INSTANCES` Indicates that CREATE_BATCH_DELETE_DECISION_INSTANCES interactions are permitted
`CREATE_BATCH_DELETE_FINISHED_PROCESS_INSTANCES` Indicates that CREATE_BATCH_DELETE_FINISHED_PROCESS_INSTANCES interactions are permitted.
`CREATE_BATCH_DELETE_RUNNING_PROCESS_INSTANCES` Indicates that CREATE_BATCH_DELETE_RUNNING_PROCESS_INSTANCES interactions are permitted
`CREATE_BATCH_MIGRATE_PROCESS_INSTANCES` Indicates that CREATE_BATCH_MIGRATE_PROCESS_INSTANCES interactions are permitted.
`CREATE_BATCH_MODIFY_PROCESS_INSTANCES` Indicates that CREATE_BATCH_MODIFY_PROCESS_INSTANCES interactions are permitted
`CREATE_BATCH_RESTART_PROCESS_INSTANCES` Indicates that CREATE_BATCH_RESTART_PROCESS_INSTANCES interactions are permitted
`CREATE_BATCH_SET_EXTERNAL_TASK_RETRIES` Indicates that CREATE_BATCH_SET_EXTERNAL_TASK_RETRIES interactions are permitted
`CREATE_BATCH_SET_JOB_RETRIES` Indicates that CREATE_BATCH_SET_JOB_RETRIES interactions are permitted
`CREATE_BATCH_SET_REMOVAL_TIME` Indicates that CREATE_BATCH_SET_REMOVAL_TIME interactions are permitted
`CREATE_BATCH_SET_VARIABLES` Indicates that CREATE_BATCH_SET_VARIABLES interactions are permitted
`CREATE_BATCH_UPDATE_PROCESS_INSTANCES_SUSPEND` Indicates that CREATE_BATCH_UPDATE_PROCESS_INSTANCES_SUSPEND interactions are permitted
`DELETE` Indicates that DELETE interactions are permitted.
`DELETE_HISTORY` Indicates that DELETE_HISTORY interactions are permitted.
`NONE` The none permission means 'no action', 'doing nothing'.
`READ` Indicates that READ interactions are permitted.
`READ_HISTORY` Indicates that READ_HISTORY interactions are permitted.
`UPDATE` Indicates that UPDATE interactions are permitted.

Field Summary

Fields
Modifier and Type Field and Description

protected int id

protected String name

protected static Resource[] RESOURCES

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Permission`	`forName(String name)`
`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 BatchPermissions`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static BatchPermissions[]`	`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 BatchPermissions NONE
```
    The none permission means 'no action', 'doing nothing'. It does not mean that no permissions are granted.
  - ALL
```
public static final BatchPermissions 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 revoke also the ALL permission is revoked, because the user is not authorized to execute all actions anymore.
  - READ
```
public static final BatchPermissions READ
```
    Indicates that READ interactions are permitted.
  - UPDATE
```
public static final BatchPermissions UPDATE
```
    Indicates that UPDATE interactions are permitted.
  - CREATE
```
public static final BatchPermissions CREATE
```
    Indicates that CREATE interactions are permitted.
  - DELETE
```
public static final BatchPermissions DELETE
```
    Indicates that DELETE interactions are permitted.
  - READ_HISTORY
```
public static final BatchPermissions READ_HISTORY
```
    Indicates that READ_HISTORY interactions are permitted.
  - DELETE_HISTORY
```
public static final BatchPermissions DELETE_HISTORY
```
    Indicates that DELETE_HISTORY interactions are permitted.
  - CREATE_BATCH_MIGRATE_PROCESS_INSTANCES
```
public static final BatchPermissions CREATE_BATCH_MIGRATE_PROCESS_INSTANCES
```
    Indicates that CREATE_BATCH_MIGRATE_PROCESS_INSTANCES interactions are permitted.
  - CREATE_BATCH_MODIFY_PROCESS_INSTANCES
```
public static final BatchPermissions CREATE_BATCH_MODIFY_PROCESS_INSTANCES
```
    Indicates that CREATE_BATCH_MODIFY_PROCESS_INSTANCES interactions are permitted
  - CREATE_BATCH_RESTART_PROCESS_INSTANCES
```
public static final BatchPermissions CREATE_BATCH_RESTART_PROCESS_INSTANCES
```
    Indicates that CREATE_BATCH_RESTART_PROCESS_INSTANCES interactions are permitted
  - CREATE_BATCH_DELETE_RUNNING_PROCESS_INSTANCES
```
public static final BatchPermissions CREATE_BATCH_DELETE_RUNNING_PROCESS_INSTANCES
```
    Indicates that CREATE_BATCH_DELETE_RUNNING_PROCESS_INSTANCES interactions are permitted
  - CREATE_BATCH_DELETE_FINISHED_PROCESS_INSTANCES
```
public static final BatchPermissions CREATE_BATCH_DELETE_FINISHED_PROCESS_INSTANCES
```
    Indicates that CREATE_BATCH_DELETE_FINISHED_PROCESS_INSTANCES interactions are permitted.
  - CREATE_BATCH_DELETE_DECISION_INSTANCES
```
public static final BatchPermissions CREATE_BATCH_DELETE_DECISION_INSTANCES
```
    Indicates that CREATE_BATCH_DELETE_DECISION_INSTANCES interactions are permitted
  - CREATE_BATCH_SET_JOB_RETRIES
```
public static final BatchPermissions CREATE_BATCH_SET_JOB_RETRIES
```
    Indicates that CREATE_BATCH_SET_JOB_RETRIES interactions are permitted
  - CREATE_BATCH_SET_EXTERNAL_TASK_RETRIES
```
public static final BatchPermissions CREATE_BATCH_SET_EXTERNAL_TASK_RETRIES
```
    Indicates that CREATE_BATCH_SET_EXTERNAL_TASK_RETRIES interactions are permitted
  - CREATE_BATCH_UPDATE_PROCESS_INSTANCES_SUSPEND
```
public static final BatchPermissions CREATE_BATCH_UPDATE_PROCESS_INSTANCES_SUSPEND
```
    Indicates that CREATE_BATCH_UPDATE_PROCESS_INSTANCES_SUSPEND interactions are permitted
  - CREATE_BATCH_SET_REMOVAL_TIME
```
public static final BatchPermissions CREATE_BATCH_SET_REMOVAL_TIME
```
    Indicates that CREATE_BATCH_SET_REMOVAL_TIME interactions are permitted
  - CREATE_BATCH_SET_VARIABLES
```
public static final BatchPermissions CREATE_BATCH_SET_VARIABLES
```
    Indicates that CREATE_BATCH_SET_VARIABLES interactions are permitted
- Field Detail
  - RESOURCES
```
protected static final Resource[] RESOURCES
```
  - name
```
protected String name
```
  - id
```
protected int id
```
- Method Detail
  - values
```
public static BatchPermissions[] 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 (BatchPermissions c : BatchPermissions.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static BatchPermissions valueOf(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:
    
    IllegalArgumentException - if this enum type 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
  - forName
```
public static Permission forName(String name)
```

Enum BatchPermissions

Enum Constant Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

NONE

ALL

READ

UPDATE

CREATE

DELETE

READ_HISTORY

DELETE_HISTORY

CREATE_BATCH_MIGRATE_PROCESS_INSTANCES

CREATE_BATCH_MODIFY_PROCESS_INSTANCES

CREATE_BATCH_RESTART_PROCESS_INSTANCES

CREATE_BATCH_DELETE_RUNNING_PROCESS_INSTANCES

CREATE_BATCH_DELETE_FINISHED_PROCESS_INSTANCES

CREATE_BATCH_DELETE_DECISION_INSTANCES

CREATE_BATCH_SET_JOB_RETRIES

CREATE_BATCH_SET_EXTERNAL_TASK_RETRIES

CREATE_BATCH_UPDATE_PROCESS_INSTANCES_SUSPEND

CREATE_BATCH_SET_REMOVAL_TIME

CREATE_BATCH_SET_VARIABLES

Field Detail

RESOURCES

name

id

Method Detail

values

valueOf

getName

getValue

getTypes

forName