com.marklogic.client.query

Interface RawStructuredQueryDefinition

All Superinterfaces:

QueryDefinition, RawQueryDefinition, SearchQueryDefinition

public interface RawStructuredQueryDefinition
extends RawQueryDefinition

A RawStructuredQueryDefinition provides access to a structured 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.
java.lang.String	serialize() Returns the structured query definition as a serialized XML string.
void	setCriteria(java.lang.String criteria) Sets the query criteria as a query string.
RawStructuredQueryDefinition	withCriteria(java.lang.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.RawQueryDefinition

getHandle, 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

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

java.lang.String serialize()

Returns the structured query definition as a serialized XML string.

Returns:

The serialized definition.

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

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