com.marklogic.client.query

Interface RawCtsQueryDefinition

All Superinterfaces:

QueryDefinition, RawQueryDefinition, SearchQueryDefinition, ValueQueryDefinition

public interface RawCtsQueryDefinition
extends RawQueryDefinition, ValueQueryDefinition

A RawCtsQueryDefinition allows you to create a query with a serialized cts query in a JSON or XML representation.

Method Summary

Modifier and Type	Method and Description
java.lang.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(java.lang.String criteria) Sets the query criteria as a query string.
RawCtsQueryDefinition	withCriteria(java.lang.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.RawQueryDefinition

setHandle

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

getCollections, getDirectory, setCollections, setDirectory

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

getOptionsName, getResponseTransform, setOptionsName, setResponseTransform

Method Detail

getCriteria

java.lang.String getCriteria()

Returns the query criteria, that is the query string.

Returns:

The query string.

setCriteria

void setCriteria(java.lang.String criteria)

Sets the query criteria as a query string.

Parameters:

criteria - The query string.

withCriteria

RawCtsQueryDefinition withCriteria(java.lang.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.