Package com.veeva.vault.sdk.api.action

Enum Class Usage

java.lang.Object

java.lang.Enum<Usage>

com.veeva.vault.sdk.api.action.Usage

All Implemented Interfaces:

Serializable, Comparable<Usage>, Constable

public enum Usage
extends Enum<Usage>

Where in Vault the action is available for configuration and execution.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
LIFECYCLE_ENTRY_ACTION	The action supports use as an entry action and event action.
UNSPECIFIED	The action is available everywhere actions are supported with the exception of bulk actions.
USER_ACTION	The action supports use as a user action.
USER_BULK_ACTION	The action supports use as a bulk action.
WORKFLOW_CANCEL	The action supports use as a workflow cancellation action.
WORKFLOW_STEP	The action supports use in an object workflow system step.

Method Summary

Modifier and Type	Method	Description
static Usage	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Usage[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

USER_ACTION

public static final Usage USER_ACTION

The action supports use as a user action.

LIFECYCLE_ENTRY_ACTION

public static final Usage LIFECYCLE_ENTRY_ACTION

The action supports use as an entry action and event action.

WORKFLOW_STEP

public static final Usage WORKFLOW_STEP

The action supports use in an object workflow system step.

WORKFLOW_CANCEL

public static final Usage WORKFLOW_CANCEL

The action supports use as a workflow cancellation action.

UNSPECIFIED

public static final Usage UNSPECIFIED

The action is available everywhere actions are supported with the exception of bulk actions.

USER_BULK_ACTION

public static final Usage USER_BULK_ACTION

The action supports use as a bulk action. Can only be used with record actions. Actions annotated with this enum cannot be annotated as any other type of action.

Method Details

values

public static Usage[] 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 Usage 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