com.marklogic.client.query

Interface SearchQueryDefinition

All Known Subinterfaces:

CtsQueryDefinition, DeleteQueryDefinition, PojoQueryDefinition, QueryDefinition, RawCombinedQueryDefinition, RawCtsQueryDefinition, RawQueryByExampleDefinition, RawQueryDefinition, RawStructuredQueryDefinition, SPARQLQueryDefinition, StringQueryDefinition, StructuredQueryBuilder.Box, StructuredQueryBuilder.Circle, StructuredQueryBuilder.Point, StructuredQueryBuilder.Polygon, StructuredQueryBuilder.Region, StructuredQueryDefinition, ValueQueryDefinition

All Known Implementing Classes:

com.marklogic.client.impl.AbstractQueryDefinition, com.marklogic.client.impl.AbstractSearchQueryDefinition, StructuredQueryBuilder.AbstractStructuredQuery, StructuredQueryBuilder.AndNotQuery, StructuredQueryBuilder.AndQuery, StructuredQueryBuilder.BoxImpl, StructuredQueryBuilder.CircleImpl, StructuredQueryBuilder.CollectionConstraintQuery, StructuredQueryBuilder.CollectionQuery, StructuredQueryBuilder.ContainerQuery, StructuredQueryBuilder.CustomConstraintQuery, StructuredQueryBuilder.DirectoryQuery, StructuredQueryBuilder.DocumentFragmentQuery, StructuredQueryBuilder.DocumentQuery, StructuredQueryBuilder.GeospatialConstraintQuery, StructuredQueryBuilder.GeospatialPointQuery, StructuredQueryBuilder.GeospatialRegionConstraintQuery, StructuredQueryBuilder.GeospatialRegionQuery, StructuredQueryBuilder.LocksQuery, StructuredQueryBuilder.NearQuery, StructuredQueryBuilder.NotQuery, StructuredQueryBuilder.OrQuery, StructuredQueryBuilder.PointImpl, StructuredQueryBuilder.PolygonImpl, StructuredQueryBuilder.PropertiesConstraintQuery, StructuredQueryBuilder.PropertiesQuery, StructuredQueryBuilder.RangeConstraintQuery, StructuredQueryBuilder.RangeQuery, StructuredQueryBuilder.RegionImpl, StructuredQueryBuilder.TemporalLsqtQuery, StructuredQueryBuilder.TemporalPeriod, StructuredQueryBuilder.TemporalPeriodCompareQuery, StructuredQueryBuilder.TemporalPeriodRangeQuery, StructuredQueryBuilder.TermQuery, StructuredQueryBuilder.TimeQuery, StructuredQueryBuilder.ValueConstraintQuery, StructuredQueryBuilder.ValueQuery, StructuredQueryBuilder.WordConstraintQuery, StructuredQueryBuilder.WordQuery

public interface SearchQueryDefinition

A SearchQueryDefinition represents the common parts of all kinds of searches that can be performed.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getOptionsName() Returns the name of the query options used for this query.
ServerTransform	getResponseTransform() Returns the transform that modifies responses to this query on the server.
void	setOptionsName(java.lang.String name) Sets the name of the query options to be used for this query.
void	setResponseTransform(ServerTransform transform) Specifies a transform that modifies responses to this query on the server.

Method Detail

getOptionsName

java.lang.String getOptionsName()

Returns the name of the query options used for this query.

Returns:

The options name.

setOptionsName

void setOptionsName(java.lang.String name)

Sets the name of the query options to be used for this query. If no query options node with the specified name exists, the search will fail.

Parameters:

name - The name of the saved query options node on the server.

getResponseTransform

ServerTransform getResponseTransform()

Returns the transform that modifies responses to this query on the server.

Returns:

The transform.

setResponseTransform

void setResponseTransform(ServerTransform transform)

Specifies a transform that modifies responses to this query on the server.

Parameters:

transform - A server transform to modify the query response.