Interface RawCtsQueryDefinition

All Superinterfaces:

QueryDefinition, RawQueryDefinition, SearchQueryDefinition, ValueQueryDefinition

• Method Summary

  All MethodsInstance MethodsAbstract Methods

  Modifier and Type

  Method

  Description

  String

  getCriteria()

  Returns the query criteria, that is the query string.

  CtsQueryWriteHandle

  getHandle()

  Returns the handle for the JSON or XML representation of the query.

  void

  setCriteria(String criteria)

  Sets the query criteria as a query string.

  RawCtsQueryDefinition

  withCriteria(String criteria)

  Sets the query criteria as a query string and returns the query definition as a fluent convenience.

  RawCtsQueryDefinition

  withHandle(StructureWriteHandle handle)

  Specifies the handle for the JSON or XML representation of a combined query and returns the query definition.

  Methods inherited from interface com.marklogic.client.query.QueryDefinition

  getCollections, getDirectory, setCollections, setDirectory

  Methods inherited from interface com.marklogic.client.query.RawQueryDefinition

  setHandle

  Methods inherited from interface com.marklogic.client.query.SearchQueryDefinition

  getOptionsName, getResponseTransform, setOptionsName, setResponseTransform

• Method Details

  • getCriteria

    String getCriteria()
    Returns the query criteria, that is the query string.

    Returns:

    The query string.

  • setCriteria

    void setCriteria(String criteria)
    Sets the query criteria as a query string.

    Parameters:

    criteria - The query string.

  • withCriteria

    RawCtsQueryDefinition withCriteria(String criteria)
    Sets the query criteria as a query string and returns the query definition as a fluent convenience.

    Parameters:

    criteria - The query string.

    Returns:

    This query definition.

  • getHandle

    CtsQueryWriteHandle getHandle()
    Returns the handle for the JSON or XML representation of the query.

    Specified by:

    getHandle in interface RawQueryDefinition

    Returns:

    the JSON or XML handle.

  • withHandle

    RawCtsQueryDefinition withHandle(StructureWriteHandle handle)
    Specifies the handle for the JSON or XML representation of a combined query and returns the query definition.

    Parameters:

    handle - the JSON or XML handle.

    Returns:

    the query definition.

Copyright (c) 2010-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.