com.haulmont.cuba.core

Interface Query

All Known Subinterfaces:

TypedQuery<T>

All Known Implementing Classes:

QueryImpl

public interface Query

Interface used to control query execution.
Consider use of TypedQuery instead of this interface.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME

Method Summary

Modifier and Type	Method and Description
Query	addView(java.lang.Class<? extends Entity> entityClass, java.lang.String viewName) Adds View for this Query instance.
Query	addView(View view) Adds View for this Query instance.
int	executeUpdate() Execute an update or delete statement.
javax.persistence.Query	getDelegate()
java.lang.Object	getFirstResult() Execute a SELECT query. Returns null if there is no result. Returns first result if more than one result.
java.lang.String	getQueryString() Get the query string.
java.util.List	getResultList() Execute a SELECT query and return the query results as a List.
java.lang.Object	getSingleResult() Execute a SELECT query that returns a single result.
Query	setCacheable(boolean cacheable) Indicates that the query results should be cached.
Query	setFirstResult(int startPosition) Set the position of the first result to retrieve.
Query	setFlushMode(javax.persistence.FlushModeType flushMode) Set the flush mode type to be used for the query execution.
Query	setLockMode(javax.persistence.LockModeType lockMode) Set the lock mode type to be used for the query execution.
Query	setMaxResults(int maxResult) Set the maximum number of results to retrieve.
Query	setParameter(int position, java.util.Date value, javax.persistence.TemporalType temporalType) Bind an instance of java.util.Date to a positional parameter.
Query	setParameter(int position, java.lang.Object value) Bind an argument to a positional parameter.
Query	setParameter(int position, java.lang.Object value, boolean implicitConversions) Bind an argument to a positional parameter.
Query	setParameter(java.lang.String name, java.util.Date value, javax.persistence.TemporalType temporalType) Bind an instance of java.util.Date to a named parameter.
Query	setParameter(java.lang.String name, java.lang.Object value) Bind an argument to a named parameter. In the query text, named parameters are marked with colon (e.g.
Query	setParameter(java.lang.String name, java.lang.Object value, boolean implicitConversions) Bind an argument to a named parameter. In the query text, named parameters are marked with colon (e.g.
Query	setQueryString(java.lang.String queryString) Set the query string.
Query	setView(java.lang.Class<? extends Entity> entityClass, java.lang.String viewName) Set View for this Query instance.
Query	setView(View view) Set View for this Query instance.

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

Method Detail

getQueryString

java.lang.String getQueryString()

Get the query string.

Returns:

query string

setQueryString

Query setQueryString(java.lang.String queryString)

Set the query string.

Parameters:

queryString - query string

getResultList

java.util.List getResultList()

Execute a SELECT query and return the query results as a List.

Returns:

a list of the results

Throws:

java.lang.IllegalStateException - if called for a Java Persistence query language UPDATE or DELETE statement

getSingleResult

java.lang.Object getSingleResult()

Execute a SELECT query that returns a single result.

Returns:

the result

Throws:

javax.persistence.NoResultException - if there is no result

javax.persistence.NonUniqueResultException - if more than one result

java.lang.IllegalStateException - if called for a Java Persistence query language UPDATE or DELETE statement

getFirstResult

@Nullable
java.lang.Object getFirstResult()

Execute a SELECT query.
Returns null if there is no result.
Returns first result if more than one result.

Returns:

the result

Throws:

java.lang.IllegalStateException - if called for a Java Persistence query language UPDATE or DELETE statement

executeUpdate

int executeUpdate()

Execute an update or delete statement.

Returns:

the number of entities updated or deleted

Throws:

java.lang.IllegalStateException - if called for a Java Persistence query language SELECT statement

javax.persistence.TransactionRequiredException - if there is no transaction

setMaxResults

Query setMaxResults(int maxResult)

Set the maximum number of results to retrieve.

Returns:

the same query instance

Throws:

java.lang.IllegalArgumentException - if argument is negative

setFirstResult

Query setFirstResult(int startPosition)

Set the position of the first result to retrieve.

Parameters:

startPosition - position of the first result, numbered from 0

Returns:

the same query instance

Throws:

java.lang.IllegalArgumentException - if argument is negative

setParameter

Query setParameter(java.lang.String name,
                   java.lang.Object value)

Bind an argument to a named parameter.

In the query text, named parameters are marked with colon (e.g. :foo) in JPQL queries or with number sign in native SQL queries (e.g. #foo).

Parameters:

name - parameter name

value - parameter value. Entity instance replaced with its ID.

Returns:

the same query instance

Throws:

java.lang.IllegalArgumentException - if parameter name does not correspond to parameter in query string or argument is of incorrect type

setParameter

Query setParameter(java.lang.String name,
                   java.lang.Object value,
                   boolean implicitConversions)

Bind an argument to a named parameter.

In the query text, named parameters are marked with colon (e.g. :foo) in JPQL queries or with number sign in native SQL queries (e.g. #foo).

Parameters:

name - parameter name

value - parameter value

implicitConversions - whether to make parameter value conversions, e.g. convert an entity to its ID

Returns:

the same query instance

Throws:

java.lang.IllegalArgumentException - if parameter name does not correspond to parameter in query string or argument is of incorrect type

setParameter

Query setParameter(java.lang.String name,
                   java.util.Date value,
                   javax.persistence.TemporalType temporalType)

Bind an instance of java.util.Date to a named parameter.

In the query text, named parameters are marked with colon (e.g. :foo) in JPQL queries or with number sign in native SQL queries (e.g. #foo).

Parameters:

name - parameter name

value - parameter value

temporalType - type of Date value

Returns:

the same query instance

Throws:

java.lang.IllegalArgumentException - if parameter name does not correspond to parameter in query string

setParameter

Query setParameter(int position,
                   java.lang.Object value)

Bind an argument to a positional parameter.

In the query text, positional parameters are marked with ?N (e.g. ?1).

Parameters:

position - parameter position, starting with 1

value - parameter value. Entity instance replaced with its ID.

Returns:

the same query instance

Throws:

java.lang.IllegalArgumentException - if position does not correspond to positional parameter of query or argument is of incorrect type

setParameter

Query setParameter(int position,
                   java.lang.Object value,
                   boolean implicitConversions)

Bind an argument to a positional parameter.

In the query text, positional parameters are marked with ?N (e.g. ?1).

Parameters:

position - parameter position, starting with 1

value - parameter value

implicitConversions - whether to make parameter value conversions, e.g. convert an entity to its ID

Returns:

the same query instance

Throws:

java.lang.IllegalArgumentException - if position does not correspond to positional parameter of query or argument is of incorrect type

setParameter

Query setParameter(int position,
                   java.util.Date value,
                   javax.persistence.TemporalType temporalType)

Bind an instance of java.util.Date to a positional parameter.
In the query text, positional parameters are marked with ?N (e.g. ?1).

Parameters:

position - parameter position, starting with 1

value - parameter value

temporalType - type of Date value

Returns:

the same query instance

Throws:

java.lang.IllegalArgumentException - if position does not correspond to positional parameter of query

setLockMode

Query setLockMode(javax.persistence.LockModeType lockMode)

Set the lock mode type to be used for the query execution.

Parameters:

lockMode - lock mode

Returns:

the same query instance

setView

Query setView(@Nullable
              View view)

Set View for this Query instance.
All non-lazy view properties contained in a combination of all added views are eagerly fetched.

Parameters:

view - view instance. If null, eager fetching is performed according to JPA mappings.

Returns:

the same query instance

setView

Query setView(java.lang.Class<? extends Entity> entityClass,
              java.lang.String viewName)

Set View for this Query instance.
All non-lazy view properties contained in a combination of all added views are eagerly fetched.

Parameters:

entityClass - entity class to get a view instance by the name provided

viewName - view name

Returns:

the same query instance

addView

Query addView(View view)

Adds View for this Query instance.
All non-lazy view properties contained in a combination of all added views are eagerly fetched.

Parameters:

view - view instance - must not be null

Returns:

the same query instance

addView

Query addView(java.lang.Class<? extends Entity> entityClass,
              java.lang.String viewName)

Adds View for this Query instance.
All non-lazy view properties contained in a combination of all added views are eagerly fetched.

Parameters:

entityClass - entity class to get a view instance by the name provided

viewName - view name - must not be null

Returns:

the same query instance

setCacheable

Query setCacheable(boolean cacheable)

Indicates that the query results should be cached.

Returns:

the same query instance

setFlushMode

Query setFlushMode(javax.persistence.FlushModeType flushMode)

Set the flush mode type to be used for the query execution.

Parameters:

flushMode - flush mode

Returns:

the same query instance

getDelegate

javax.persistence.Query getDelegate()

Returns:

underlying implementation provided by ORM