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

Interface QueryCountRequest.Builder

Enclosing interface:

QueryCountRequest

public static interface QueryCountRequest.Builder

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

Method Summary

Modifier and Type	Method	Description
QueryCountRequest	build()	Retrieves the completed QueryCountRequest.
QueryCountRequest.Builder	withQuery(Query query)	Sets the VQL Query, replacing any previously set Query or query string.
QueryCountRequest.Builder	withQueryFacetRequest(QueryFacetRequest queryFacetRequest)	Sets the QueryFacetRequest, replacing any previously set QueryFacetRequest.
QueryCountRequest.Builder	withQueryString(String queryString)	Sets the VQL query string, replacing any previously set query string or Query.
QueryCountRequest.Builder	withTokenRequest(TokenRequest tokenRequest, QueryEscapeOverride... escapeOverrides)	Sets the TokenRequest and QueryEscapeOverride(s), replacing any previously set TokenRequest and QueryEscapeOverride(s).

Method Details

withQuery

QueryCountRequest.Builder withQuery(Query query)

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

Parameters:

query - VQL query to be executed

Returns:

this Builder

withQueryString

QueryCountRequest.Builder withQueryString(String queryString)

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

Parameters:

queryString - VQL query string to be executed

Returns:

this Builder

withTokenRequest

QueryCountRequest.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

withQueryFacetRequest

QueryCountRequest.Builder withQueryFacetRequest(QueryFacetRequest queryFacetRequest)

Sets the QueryFacetRequest, replacing any previously set QueryFacetRequest.

Parameters:

queryFacetRequest - a request containing the fields to facet on and options for running the facet query

Returns:

this Builder

build

QueryCountRequest build()

Retrieves the completed QueryCountRequest.

The query must be non-null.

Returns:

the completed QueryCountRequest