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

Interface QueryExecutionResponse

public interface QueryExecutionResponse
Represents the result of a VQL query execution.

  • Method Details

    • getQueryString

      String getQueryString()
      Retrieves the executed query string. If tokens are used, then the tokens in the query string are resolved.
      Returns:
      the executed query string

    • getResultCount

      long getResultCount()
      Retrieves the total number of results satisfying the query.
      Returns:
      the total number of results satisfying the query

    • streamResults

      Stream<QueryExecutionResult> streamResults()
      Streams the query results in the native query format, QueryExecutionResult.

      This stream returns all results qualified by the query. There is no concept of result pages as seen in the VQL API.

      To traverse the stream results in the classic iterator model, use the returned stream's BaseStream.iterator() method.

      Returns:
      the query results in the native query format

    • hasFacetResponse

      boolean hasFacetResponse()
      Checks whether the response contains a QueryFacetResponse.
      Returns:
      true if the response contains a facet response, false otherwise

    • getFacetResponse

      QueryFacetResponse getFacetResponse()
      Retrieves the QueryFacetResponse.
      Returns:
      the QueryFacetResponse

    • hasQueryDescribeResult

      boolean hasQueryDescribeResult()
      Checks whether the response contains a QueryDescribeResult.
      Returns:
      true if the response contains a QueryDescribeResult, otherwise false

    • getQueryDescribeResult

      QueryDescribeResult getQueryDescribeResult()
      Retrieves the QueryDescribeResult. Throws an exception if the response does not contain a QueryDescribeResult.
      Returns:
      the QueryDescribeResult