Package com.veeva.vault.sdk.api.query

Enum Class QueryTargetOption

java.lang.Object

java.lang.Enum<QueryTargetOption>

com.veeva.vault.sdk.api.query.QueryTargetOption

All Implemented Interfaces:

Serializable, Comparable<QueryTargetOption>, Constable

public enum QueryTargetOption
extends Enum<QueryTargetOption>

Valid options to modify the scope of a VQL query target.

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
ALLVERSIONS	Indicates all matching versions should be returned.
LATEST_FROM_ALLVERSIONS	Indicates the latest matching version should be returned, even if it is not the absolute latest version.

Method Summary

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

LATEST_FROM_ALLVERSIONS

public static final QueryTargetOption LATEST_FROM_ALLVERSIONS

Indicates the latest matching version should be returned, even if it is not the absolute latest version. This option is supported on queries against documents or binders only.

This is equivalent to using the LATESTVERSION and ALLVERSIONS keywords in a VQL query.

SELECT LATESTVERSION id, name__v FROM ALLVERSIONS documents

ALLVERSIONS

public static final QueryTargetOption ALLVERSIONS

Indicates all matching versions should be returned. Note that multiple versions of the same record can be returned. This option is supported on queries against documents or binders only.

This is equivalent to using the ALLVERSIONS keyword in a VQL query.

SELECT id, name__v FROM ALLVERSIONS documents

Method Details

values

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