ActionType (Rice KEW API 2.5.11 API)

java.lang.Object
- java.lang.Enum<ActionType>
- - org.kuali.rice.kew.api.action.ActionType

All Implemented Interfaces:

Serializable, Comparable<ActionType>, Coded
```
public enum ActionType
extends Enum<ActionType>
implements Coded
```
An enumeration which indicates valid actions that can be taken against workflow documents.

Author:

Kuali Rice Team (rice.collab@kuali.org)

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ACKNOWLEDGE` Document has been opened by the designated recipient.
`ADHOC_REQUEST` User has generated an action request to another user
`ADHOC_REQUEST_REVOKE` AdHoc Request has been revoked
`APPROVE` The document has been approved.
`BLANKET_APPROVE`
`CANCEL` Document has been canceled.
`COMPLETE` Document has been completed as requested.
`DISAPPROVE` Document has been disapproved.
`FYI`
`LOG_MESSAGE` The document has non-routed activity against it that is recorded in the route log
`MOVE` The document is moved
`RECALL` The document is being recalled.
`RELEASE_GROUP_AUTHORITY` The person who took group authority is releasing it
`RETURN_TO_PREVIOUS` The document is being returned to a previous routelevel
`ROUTE` Document has been submitted to the engine for processing.
`SAVE` Document has been saved by the user for later work
`SU_ACKNOWLEDGE`
`SU_APPROVE`
`SU_BLANKET_APPROVE`
`SU_CANCEL`
`SU_COMPLETE`
`SU_DISAPPROVE`
`SU_FYI`
`SU_RETURN_TO_PREVIOUS`
`SU_ROUTE_NODE_APPROVE`
`TAKE_GROUP_AUTHORITY` The document is routed to a group and a user in the group wants to take authority from the group

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ActionType`	`fromCode(String code)`
`static ActionType`	`fromCode(String code, boolean allowMissing)`
`static ActionType`	`fromCodeOrLabel(String str)`
`static ActionType`	`fromLabel(String label)`
`String`	`getCode()`
`String`	`getLabel()`
`static ActionType`	`toSuperUserActionType(ActionType at)` Converts a non-super-user ActionType to its SuperUser equivalent
`static ActionType`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static ActionType[]`	`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
  - SU_ACKNOWLEDGE
```
public static final ActionType SU_ACKNOWLEDGE
```
  - SU_FYI
```
public static final ActionType SU_FYI
```
  - SU_COMPLETE
```
public static final ActionType SU_COMPLETE
```
  - SU_APPROVE
```
public static final ActionType SU_APPROVE
```
  - SU_ROUTE_NODE_APPROVE
```
public static final ActionType SU_ROUTE_NODE_APPROVE
```
  - SU_RETURN_TO_PREVIOUS
```
public static final ActionType SU_RETURN_TO_PREVIOUS
```
  - SU_DISAPPROVE
```
public static final ActionType SU_DISAPPROVE
```
  - SU_CANCEL
```
public static final ActionType SU_CANCEL
```
  - SU_BLANKET_APPROVE
```
public static final ActionType SU_BLANKET_APPROVE
```
  - BLANKET_APPROVE
```
public static final ActionType BLANKET_APPROVE
```
  - FYI
```
public static final ActionType FYI
```
  - ADHOC_REQUEST
```
public static final ActionType ADHOC_REQUEST
```
    User has generated an action request to another user
  - ADHOC_REQUEST_REVOKE
```
public static final ActionType ADHOC_REQUEST_REVOKE
```
    AdHoc Request has been revoked
  - SAVE
```
public static final ActionType SAVE
```
    Document has been saved by the user for later work
  - CANCEL
```
public static final ActionType CANCEL
```
    Document has been canceled.
  - DISAPPROVE
```
public static final ActionType DISAPPROVE
```
    Document has been disapproved.
  - ACKNOWLEDGE
```
public static final ActionType ACKNOWLEDGE
```
    Document has been opened by the designated recipient.
  - COMPLETE
```
public static final ActionType COMPLETE
```
    Document has been completed as requested.
  - ROUTE
```
public static final ActionType ROUTE
```
    Document has been submitted to the engine for processing.
  - APPROVE
```
public static final ActionType APPROVE
```
    The document has been approved.
  - RETURN_TO_PREVIOUS
```
public static final ActionType RETURN_TO_PREVIOUS
```
    The document is being returned to a previous routelevel
  - RECALL
```
public static final ActionType RECALL
```
    The document is being recalled.
    
    Since:
    
    2.1
  - LOG_MESSAGE
```
public static final ActionType LOG_MESSAGE
```
    The document has non-routed activity against it that is recorded in the route log
  - TAKE_GROUP_AUTHORITY
```
public static final ActionType TAKE_GROUP_AUTHORITY
```
    The document is routed to a group and a user in the group wants to take authority from the group
  - RELEASE_GROUP_AUTHORITY
```
public static final ActionType RELEASE_GROUP_AUTHORITY
```
    The person who took group authority is releasing it
  - MOVE
```
public static final ActionType MOVE
```
    The document is moved
- Method Detail
  - values
```
public static ActionType[] 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 (ActionType c : ActionType.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static ActionType 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
  - getCode
```
public String getCode()
```
    Specified by:
    
    getCode in interface Coded
  - getLabel
```
public String getLabel()
```
  - fromCode
```
public static ActionType fromCode(String code)
```
  - fromCode
```
public static ActionType fromCode(String code,
                                  boolean allowMissing)
```
  - fromLabel
```
public static ActionType fromLabel(String label)
```
  - fromCodeOrLabel
```
public static ActionType fromCodeOrLabel(String str)
```
  - toSuperUserActionType
```
public static ActionType toSuperUserActionType(ActionType at)
```
    Converts a non-super-user ActionType to its SuperUser equivalent
    
    Parameters:
    
    at - the ActionType
    
    Returns:
    
    super-user version of ActionType or null if no equivalent SU action type
    
    Since:
    
    2.1.3

Enum ActionType

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

SU_ACKNOWLEDGE

SU_FYI

SU_COMPLETE

SU_APPROVE

SU_ROUTE_NODE_APPROVE

SU_RETURN_TO_PREVIOUS

SU_DISAPPROVE

SU_CANCEL

SU_BLANKET_APPROVE

BLANKET_APPROVE

FYI

ADHOC_REQUEST

ADHOC_REQUEST_REVOKE

SAVE

CANCEL

DISAPPROVE

ACKNOWLEDGE

COMPLETE

ROUTE

APPROVE

RETURN_TO_PREVIOUS

RECALL

LOG_MESSAGE

TAKE_GROUP_AUTHORITY

RELEASE_GROUP_AUTHORITY

MOVE

Method Detail

values

valueOf

getCode

getLabel

fromCode

fromCode

fromLabel

fromCodeOrLabel

toSuperUserActionType