Enum TaskPermissions
- java.lang.Object
-
- java.lang.Enum<TaskPermissions>
-
- org.camunda.bpm.engine.authorization.TaskPermissions
-
- All Implemented Interfaces:
Serializable
,Comparable<TaskPermissions>
,Permission
public enum TaskPermissions extends Enum<TaskPermissions> implements Permission
The set of built-inPermissions
forTask
in Camunda Platform.- Author:
- Yana Vasileva
-
-
Enum Constant Summary
Enum Constants Enum Constant Description ALL
Indicates that all interactions are permitted.CREATE
Indicates that CREATE interactions are permitted.DELETE
Indicates that DELETE interactions are permitted.NONE
The none permission means 'no action', 'doing nothing'.READ
Indicates that READ interactions are permitted.READ_HISTORY
Deprecated.since the permission is not used by any built-in functionality of Camunda PlatformREAD_VARIABLE
Indicates that READ_VARIABLE interactions are permitted.TASK_ASSIGN
Indicates that TASK_ASSIGN interactions are permittedTASK_WORK
Indicates that TASK_WORK interactions are permittedUPDATE
Indicates that UPDATE interactions are permitted.UPDATE_VARIABLE
Indicates that UPDATE_VARIABLE interactions are permitted.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getName()
returns the name of the permission, ie.Resource[]
getTypes()
returns the resource types which are allowed for this permissionint
getValue()
returns the unique numeric value of the permission.static TaskPermissions
valueOf(String name)
Returns the enum constant of this type with the specified name.static TaskPermissions[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
NONE
public static final TaskPermissions NONE
The none permission means 'no action', 'doing nothing'. It does not mean that no permissions are granted.
-
ALL
public static final TaskPermissions 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 TaskPermissions READ
Indicates that READ interactions are permitted.
-
UPDATE
public static final TaskPermissions UPDATE
Indicates that UPDATE interactions are permitted.
-
CREATE
public static final TaskPermissions CREATE
Indicates that CREATE interactions are permitted.
-
DELETE
public static final TaskPermissions DELETE
Indicates that DELETE interactions are permitted.
-
READ_HISTORY
@Deprecated public static final TaskPermissions READ_HISTORY
Deprecated.since the permission is not used by any built-in functionality of Camunda PlatformIndicates that READ_HISTORY interactions are permitted.
-
TASK_WORK
public static final TaskPermissions TASK_WORK
Indicates that TASK_WORK interactions are permitted
-
TASK_ASSIGN
public static final TaskPermissions TASK_ASSIGN
Indicates that TASK_ASSIGN interactions are permitted
-
UPDATE_VARIABLE
public static final TaskPermissions UPDATE_VARIABLE
Indicates that UPDATE_VARIABLE interactions are permitted.
-
READ_VARIABLE
public static final TaskPermissions READ_VARIABLE
Indicates that READ_VARIABLE interactions are permitted.
-
-
Method Detail
-
values
public static TaskPermissions[] 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 (TaskPermissions c : TaskPermissions.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static TaskPermissions 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 nameNullPointerException
- 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 interfacePermission
-
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 interfacePermission
-
getTypes
public Resource[] getTypes()
Description copied from interface:Permission
returns the resource types which are allowed for this permission- Specified by:
getTypes
in interfacePermission
-
-