Uses of Interface com.marklogic.client.query.QueryDefinition (MarkLogic Java Client API 4.2.0)

Packages that use QueryDefinition
Package	Description
com.marklogic.client.alerting	A REST interface to MarkLogic alerting capabilities.
com.marklogic.client.document	The package provides classes for creating, retrieving, updating, and deleting documents in the database for the REST server.
com.marklogic.client.impl
com.marklogic.client.io	The package provides the handle classes with different representations for document content when you read documents from the database or write documents to the database.
com.marklogic.client.pojo	The goal of this package (sometimes referred to as "the pojo facade" is to simplify working with custom Plain Old Java Objects (pojos) without hassling with persistence details.
com.marklogic.client.query	The package provides classes for queries including searching documents and reading values directly from indexes in the database for the REST server.
com.marklogic.client.semantics

Uses of QueryDefinition in com.marklogic.client.alerting

Methods in com.marklogic.client.alerting with parameters of type QueryDefinition
Modifier and Type	Method	Description
`<T extends RuleListReadHandle> T`	RuleManager.`match(QueryDefinition docQuery, long start, long pageLength, java.lang.String[] candidateRules, T ruleListHandle)`	Matches server rules based on results of a search, with pagination applied to search.
`<T extends RuleListReadHandle> T`	RuleManager.`match(QueryDefinition docQuery, long start, long pageLength, java.lang.String[] candidateRules, T ruleListHandle, ServerTransform transform)`	Matches server rules based on results of a search, with pagination applied to search.
`<T extends RuleListReadHandle> T`	RuleManager.`match(QueryDefinition docQuery, T ruleListHandle)`	Matches server rules based on the results of a search.

Uses of QueryDefinition in com.marklogic.client.document

Methods in com.marklogic.client.document with parameters of type QueryDefinition
Modifier and Type	Method	Description
`DocumentPage`	DocumentManager.`search(QueryDefinition querydef, long start)`	Just like `QueryManager.search` but return complete documents via iterable DocumentPage.
`DocumentPage`	DocumentManager.`search(QueryDefinition querydef, long start, SearchReadHandle searchHandle)`	Just like `QueryManager.search` but return complete documents via iterable DocumentPage.
`DocumentPage`	DocumentManager.`search(QueryDefinition querydef, long start, SearchReadHandle searchHandle, Transaction transaction)`	Just like `QueryManager.search(QueryDefinition, SearchReadHandle, long, Transaction)` but return complete documents via iterable DocumentPage.
`DocumentPage`	DocumentManager.`search(QueryDefinition querydef, long start, SearchReadHandle searchHandle, Transaction transaction, java.lang.String forestName)`	Just like `QueryManager.search(QueryDefinition, SearchReadHandle, long, Transaction, String)` but return complete documents via iterable DocumentPage.
`DocumentPage`	DocumentManager.`search(QueryDefinition querydef, long start, SearchReadHandle searchHandle, java.lang.String forestName)`	Just like `QueryManager.search` but return complete documents via iterable DocumentPage.
`DocumentPage`	DocumentManager.`search(QueryDefinition querydef, long start, Transaction transaction)`	Just like `QueryManager.search` but return complete documents via iterable DocumentPage.
`DocumentPage`	DocumentManager.`search(QueryDefinition querydef, long start, Transaction transaction, java.lang.String forestName)`	Just like `QueryManager.search` but return complete documents via iterable DocumentPage.
`DocumentPage`	DocumentManager.`search(QueryDefinition querydef, long start, java.lang.String forestName)`	Just like `QueryManager.search` but return complete documents via iterable DocumentPage.

Uses of QueryDefinition in com.marklogic.client.impl

Classes in com.marklogic.client.impl with annotations of type with type parameters of type that implement declared as with annotations of type with type parameters of type with annotations of type with annotations of type with type parameters of type that return that return types with arguments of type with parameters of type with type arguments of type that throw with annotations of type with annotations of type with parameters of type with type arguments of type that throw QueryDefinition
Modifier and Type	Class	Description
`class`	`com.marklogic.client.impl.AbstractQueryDefinition`

Uses of QueryDefinition in com.marklogic.client.io

Methods in com.marklogic.client.io that return QueryDefinition
Modifier and Type	Method	Description
`QueryDefinition`	SearchHandle.`getQueryCriteria()`	Returns the query definition used for the search represented by this handle.

Methods in com.marklogic.client.io with parameters of type QueryDefinition
Modifier and Type	Method	Description
`void`	SearchHandle.`setQueryCriteria(QueryDefinition querydef)`	Sets the query definition used in the search.

Uses of QueryDefinition in com.marklogic.client.pojo

Subinterfaces of QueryDefinition in com.marklogic.client.pojo
Modifier and Type	Interface	Description
`interface`	`PojoQueryDefinition`	A marker interface identifying QueryDefinition types compatible with `PojoRepository.search`

Uses of QueryDefinition in com.marklogic.client.query

Subinterfaces of QueryDefinition in com.marklogic.client.query
Modifier and Type	Interface	Description
`interface`	`DeleteQueryDefinition`	A DeleteQueryDefinition is a query definition suitable for use in performing a delete query.
`interface`	`RawCombinedQueryDefinition`	A RawCombinedQueryDefinition provides access to a combined query in a JSON or XML representation.
`interface`	`RawCtsQueryDefinition`	A RawCtsQueryDefinition allows you to create a query with a serialized cts query in a JSON or XML representation.
`interface`	`RawQueryByExampleDefinition`	A RawQueryByExampleDefinition provides access to a simple query by example in an JSON or XML representation.
`interface`	`RawQueryDefinition`	A RawQueryDefinition provides access to a query in a JSON or XML representation.
`interface`	`RawStructuredQueryDefinition`	A RawStructuredQueryDefinition provides access to a structured query in a JSON or XML representation.
`interface`	`StringQueryDefinition`	A StringQueryDefinition represents the criteria associated with a simple string query.
`static interface`	`StructuredQueryBuilder.Box`
`static interface`	`StructuredQueryBuilder.Circle`
`static interface`	`StructuredQueryBuilder.Point`
`static interface`	`StructuredQueryBuilder.Polygon`
`static interface`	`StructuredQueryBuilder.Region`	A region matched by a geospatial query.
`interface`	`StructuredQueryDefinition`	A StructuredQueryDefinition represents a structured query.
`interface`	`ValueQueryDefinition`	ValueQueryDefinitions can be used in value queries.

Classes in com.marklogic.client.query that implement QueryDefinition
Modifier and Type	Class	Description
`protected class`	`StructuredQueryBuilder.AbstractStructuredQuery`
`protected class`	`StructuredQueryBuilder.AndNotQuery`
`protected class`	`StructuredQueryBuilder.AndQuery`
`protected class`	`StructuredQueryBuilder.BoxImpl`
`protected class`	`StructuredQueryBuilder.CircleImpl`
`protected class`	`StructuredQueryBuilder.CollectionConstraintQuery`
`protected class`	`StructuredQueryBuilder.CollectionQuery`
`protected class`	`StructuredQueryBuilder.ContainerQuery`
`protected class`	`StructuredQueryBuilder.CustomConstraintQuery`
`protected class`	`StructuredQueryBuilder.DirectoryQuery`
`protected class`	`StructuredQueryBuilder.DocumentFragmentQuery`
`protected class`	`StructuredQueryBuilder.DocumentQuery`
`protected class`	`StructuredQueryBuilder.GeospatialConstraintQuery`
`protected class`	`StructuredQueryBuilder.GeospatialPointQuery`
`protected class`	`StructuredQueryBuilder.GeospatialRegionConstraintQuery`
`protected class`	`StructuredQueryBuilder.GeospatialRegionQuery`
`protected class`	`StructuredQueryBuilder.LocksQuery`
`protected class`	`StructuredQueryBuilder.NearQuery`
`protected class`	`StructuredQueryBuilder.NotQuery`
`protected class`	`StructuredQueryBuilder.OrQuery`
`protected class`	`StructuredQueryBuilder.PointImpl`
`protected class`	`StructuredQueryBuilder.PolygonImpl`
`protected class`	`StructuredQueryBuilder.PropertiesConstraintQuery`
`protected class`	`StructuredQueryBuilder.PropertiesQuery`
`protected class`	`StructuredQueryBuilder.RangeConstraintQuery`
`protected class`	`StructuredQueryBuilder.RangeQuery`
`protected class`	`StructuredQueryBuilder.RegionImpl`
`protected class`	`StructuredQueryBuilder.TemporalLsqtQuery`
`protected class`	`StructuredQueryBuilder.TemporalPeriod`
`protected class`	`StructuredQueryBuilder.TemporalPeriodCompareQuery`
`protected class`	`StructuredQueryBuilder.TemporalPeriodRangeQuery`
`protected class`	`StructuredQueryBuilder.TermQuery`
`protected class`	`StructuredQueryBuilder.TimeQuery`
`protected class`	`StructuredQueryBuilder.ValueConstraintQuery`
`protected class`	`StructuredQueryBuilder.ValueQuery`
`protected class`	`StructuredQueryBuilder.WordConstraintQuery`
`protected class`	`StructuredQueryBuilder.WordQuery`

Methods in com.marklogic.client.query that return QueryDefinition
Modifier and Type	Method	Description
`QueryDefinition`	SearchResults.`getQueryCriteria()`	Returns the query definition associated with this query.

Methods in com.marklogic.client.query with parameters of type QueryDefinition
Modifier and Type	Method	Description
`MatchDocumentSummary`	QueryManager.`findOne(QueryDefinition querydef)`	The findOne method is a convenience.
`MatchDocumentSummary`	QueryManager.`findOne(QueryDefinition querydef, Transaction transaction)`	The findOne method is a convenience.
`<T extends SearchReadHandle> T`	QueryManager.`search(QueryDefinition querydef, T searchHandle)`	Searches documents based on query criteria and, potentially, previously saved query options.
`<T extends SearchReadHandle> T`	QueryManager.`search(QueryDefinition querydef, T searchHandle, long start)`	Searches documents based on query criteria and, potentially, previously saved query options starting with the specified page listing document results.
`<T extends SearchReadHandle> T`	QueryManager.`search(QueryDefinition querydef, T searchHandle, long start, Transaction transaction)`	Searches documents based on query criteria and, potentially, previously saved query options starting with the specified page listing document results.
`<T extends SearchReadHandle> T`	QueryManager.`search(QueryDefinition querydef, T searchHandle, long start, Transaction transaction, java.lang.String forestName)`	Searches documents based on query criteria and, potentially, previously saved query options starting with the specified page listing document results.
`<T extends SearchReadHandle> T`	QueryManager.`search(QueryDefinition querydef, T searchHandle, long start, java.lang.String forestName)`	Searches documents based on query criteria and, potentially, previously saved query options starting with the specified page listing document results.
`<T extends SearchReadHandle> T`	QueryManager.`search(QueryDefinition querydef, T searchHandle, Transaction transaction)`	Searches documents based on query criteria and, potentially, previously saved query options.
`<T extends SearchReadHandle> T`	QueryManager.`search(QueryDefinition querydef, T searchHandle, Transaction transaction, java.lang.String forestName)`	Searches documents based on query criteria and, potentially, previously saved query options.
`<T extends SearchReadHandle> T`	QueryManager.`search(QueryDefinition querydef, T searchHandle, java.lang.String forestName)`	Searches documents based on query criteria and, potentially, previously saved query options.

Uses of QueryDefinition in com.marklogic.client.semantics

Subinterfaces of QueryDefinition in com.marklogic.client.semantics
Modifier and Type	Interface	Description
`interface`	`SPARQLQueryDefinition`	Represents a SPARQL query.

Methods in com.marklogic.client.semantics that return QueryDefinition
Modifier and Type	Method	Description
`QueryDefinition`	SPARQLQueryDefinition.`getConstrainingQueryDefinition()`

Methods in com.marklogic.client.semantics with parameters of type QueryDefinition
Modifier and Type	Method	Description
`void`	SPARQLQueryDefinition.`setConstrainingQueryDefinition(QueryDefinition query)`	Set the search query used to constrain the set of documents included in the SPARQL query.
`SPARQLQueryDefinition`	SPARQLQueryDefinition.`withConstrainingQuery(QueryDefinition query)`	Set the search query used to constrain the set of documents included in the SPARQL query.