Interface RawStructuredQueryDefinition

All Superinterfaces:

QueryDefinition, RawQueryDefinition, SearchQueryDefinition

• Method Summary

  All MethodsInstance MethodsAbstract Methods

  Modifier and Type

  Method

  Description

  String

  getCriteria()

  Returns the query criteria, that is the query string.

  String

  serialize()

  Returns the structured query definition as a serialized XML string.

  void

  setCriteria(String criteria)

  Sets the query criteria as a query string.

  RawStructuredQueryDefinition

  withCriteria(String criteria)

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

  RawStructuredQueryDefinition

  withHandle(StructureWriteHandle handle)

  Specifies the handle for the JSON or XML representation of a structured 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

  getHandle, setHandle

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

  getOptionsName, getResponseTransform, setOptionsName, setResponseTransform

• Method Details

  • withHandle

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

    Parameters:

    handle - the JSON or XML handle.

    Returns:

    the query definition.

  • serialize

    String serialize()
    Returns the structured query definition as a serialized XML string.

    Returns:

    The serialized definition.

  • 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

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

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