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

Interface QueryValidationRequest.Builder

Enclosing interface:

QueryValidationRequest

public static interface QueryValidationRequest.Builder

Creates an instance of QueryValidationRequest. Calling at least one method to set the query is required.

Method Summary

Modifier and Type	Method	Description
QueryValidationRequest	build()	Retrieves the completed QueryValidationRequest.
QueryValidationRequest.Builder	withQuery(Query query)	Sets the VQL Query, replacing any previously set Query or query string.
QueryValidationRequest.Builder	withQueryDescribe()	Enables Query Describe on the query.
QueryValidationRequest.Builder	withQueryString(String queryString)	Sets the VQL query string, replacing any previously set query string or Query.
QueryValidationRequest.Builder	withTokenRequest(TokenRequest tokenRequest, QueryEscapeOverride... escapeOverrides)	Sets the TokenRequest and QueryEscapeOverride(s), replacing any previously set TokenRequest and QueryEscapeOverride(s).

Method Details

withQuery

QueryValidationRequest.Builder withQuery(Query query)

Sets the VQL Query, replacing any previously set Query or query string.

Parameters:

query - VQL query to be validated

Returns:

this Builder

withQueryString

QueryValidationRequest.Builder withQueryString(String queryString)

Sets the VQL query string, replacing any previously set query string or Query.

Parameters:

queryString - VQL query string to be validated

Returns:

this Builder

withTokenRequest

QueryValidationRequest.Builder withTokenRequest(TokenRequest tokenRequest,
 QueryEscapeOverride... escapeOverrides)

Sets the TokenRequest and QueryEscapeOverride(s), replacing any previously set TokenRequest and QueryEscapeOverride(s).

Filters on a String field support tokens containing all the types listed in TokenRequest except for List. A filter using CONTAINS only supports a token containing a List. All other fields support tokens containing either their type or a String.

Vault escapes all special VQL characters in String tokens if escape overrides are not provided.

Parameters:

tokenRequest - a token request containing all custom tokens used in the query

escapeOverrides - overrides(s) indicating which characters not to escape

Returns:

this Builder

withQueryDescribe

QueryValidationRequest.Builder withQueryDescribe()

Enables Query Describe on the query.

Returns:

this Builder

build

QueryValidationRequest build()

Retrieves the completed QueryValidationRequest.

The query must be non-null.

Returns:

the completed QueryValidationRequest