com.veeva.vault.sdk.api.query

Enum QueryEscapeOverride

java.lang.Object

java.lang.Enum<QueryEscapeOverride>

com.veeva.vault.sdk.api.query.QueryEscapeOverride

All Implemented Interfaces:

Serializable, Comparable<QueryEscapeOverride>

public enum QueryEscapeOverride
extends Enum<QueryEscapeOverride>

Valid overrides for the default escape strategy in a VQL query.

ESCAPE_ALL is the default option, indicating no overrides are applied to the default strategy. Each other option indicates one or more characters should not be escaped.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ESCAPE_ALL Indicates no overrides are applied to the default escape strategy.
IGNORE_ALL Indicates no escaping is applied.
IGNORE_BACKSLASH Indicates backslashes are not escaped.
IGNORE_DOUBLE_QUOTE Indicates double quotes are not escaped.
IGNORE_PARENTHESIS Indicates open and close parentheses are not escaped.
IGNORE_SINGLE_QUOTE Indicates single quotes are not escaped.
IGNORE_WILDCARD Indicates wildcard characters are not escaped.

Method Summary

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

ESCAPE_ALL

public static final QueryEscapeOverride ESCAPE_ALL

Indicates no overrides are applied to the default escape strategy. All VQL special characters are escaped.

IGNORE_ALL

public static final QueryEscapeOverride IGNORE_ALL

Indicates no escaping is applied. Note that improperly unescaped backslashes and single quotes will cause an error.

IGNORE_BACKSLASH

public static final QueryEscapeOverride IGNORE_BACKSLASH

Indicates backslashes are not escaped. Note that improperly unescaped backslashes will cause an error. Backslashes can be used to escape other special characters or as part of escape sequences such as \n, \r, and \t.

IGNORE_WILDCARD

public static final QueryEscapeOverride IGNORE_WILDCARD

Indicates wildcard characters are not escaped. This includes asterisks, which represent the wildcard in the FIND clause, and percent signs, which represent the wildcard in LIKE filters.

IGNORE_SINGLE_QUOTE

public static final QueryEscapeOverride IGNORE_SINGLE_QUOTE

Indicates single quotes are not escaped. Note that improperly unescaped single quotes will cause an error. Single quotes can be used to escape other single quotes.

IGNORE_DOUBLE_QUOTE

public static final QueryEscapeOverride IGNORE_DOUBLE_QUOTE

Indicates double quotes are not escaped. Double quotes can be used to indicate phrases in the FIND clause.

IGNORE_PARENTHESIS

public static final QueryEscapeOverride IGNORE_PARENTHESIS

Indicates open and close parentheses are not escaped. Parentheses can be used to logically group search terms in the FIND clause.

Method Detail

values

public static QueryEscapeOverride[] 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 (QueryEscapeOverride c : QueryEscapeOverride.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static QueryEscapeOverride 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