Package com.veeva.vault.sdk.api.ai

Enum Class AiScope

java.lang.Object

java.lang.Enum<AiScope>

com.veeva.vault.sdk.api.ai.AiScope

All Implemented Interfaces:

Serializable, Comparable<AiScope>, Constable

public enum AiScope
extends Enum<AiScope>

Defines the scope of an AI element.

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
ALL	The element operates on any scope.
DOCUMENT	The element operates on a specific document.
OBJECT	The element operates on a specific object record.

Method Summary

Modifier and Type	Method	Description
static AiScope	valueOf(String name)	Returns the enum constant of this class with the specified name.
static AiScope[]	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

DOCUMENT

public static final AiScope DOCUMENT

The element operates on a specific document.

OBJECT

public static final AiScope OBJECT

The element operates on a specific object record.

ALL

public static final AiScope ALL

The element operates on any scope.

Method Details

values

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