AbstractProducedQuery (Red Hat JBoss Enterprise Application Platform 7.2.0.GA public API)

java.lang.Object
- org.hibernate.query.internal.AbstractProducedQuery<R>

All Implemented Interfaces:

Query, TypedQuery<R>, BasicQueryContract<CommonQueryContract>, CommonQueryContract, QueryImplementor<R>

Direct Known Subclasses:

CollectionFilterImpl, FullTextQueryImpl, NativeQueryImpl, ProcedureCallImpl, QueryImpl
```
public abstract class AbstractProducedQuery<R>
extends Object
implements QueryImplementor<R>
```
Author:

Steve Ebersole

Constructor Summary

Constructors
Constructor and Description

AbstractProducedQuery(SharedSessionContractImplementor producer, ParameterMetadata parameterMetadata)

Constructors
Constructor and Description
`AbstractProducedQuery(SharedSessionContractImplementor producer, ParameterMetadata parameterMetadata)`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`QueryImplementor`	`addQueryHint(String hint)` Add a DB query hint to the SQL.
`protected void`	`afterQuery()`
`protected void`	`applyAliasSpecificLockModeHint(String alias, LockMode lockMode)` Apply the alias specific lock modes.
`protected boolean`	`applyCacheableHint(boolean isCacheable)` Apply the cacheable (true/false) hint.
`protected boolean`	`applyCacheModeHint(CacheMode cacheMode)` Apply the CacheMode hint.
`protected boolean`	`applyCacheRegionHint(String regionName)` Apply the cache region hint
`protected boolean`	`applyCommentHint(String comment)` Apply the comment hint.
`protected void`	`applyEntityGraphQueryHint(EntityGraphQueryHint hint)` Used from HEM code as a (hopefully temporary) means to apply a custom query plan in regards to a JPA entity graph.
`protected boolean`	`applyFetchSizeHint(int fetchSize)` Apply the fetch size hint
`protected boolean`	`applyFlushModeHint(FlushMode flushMode)` Apply the FlushMode hint.
`protected boolean`	`applyFollowOnLockingHint(Boolean followOnLocking)` Apply the follow-on-locking hint.
`protected boolean`	`applyHibernateLockModeHint(LockMode lockMode)`
`protected boolean`	`applyJpaCacheRetrieveMode(CacheRetrieveMode mode)`
`protected boolean`	`applyJpaCacheStoreMode(CacheStoreMode storeMode)`
`protected boolean`	`applyLockModeTypeHint(LockModeType lockModeType)`
`protected boolean`	`applyLockTimeoutHint(int timeout)` Apply the lock timeout (in seconds!) hint
`protected boolean`	`applyNativeQueryLockMode(Object value)`
`protected boolean`	`applyPassDistinctThrough(boolean passDistinctThrough)` Apply the follow-on-locking hint.
`protected boolean`	`applyReadOnlyHint(boolean isReadOnly)` Apply the read-only (true/false) hint.
`protected boolean`	`applyTimeoutHint(int timeout)` Apply the query timeout hint.
`protected void`	`beforeQuery()`
`protected boolean`	`canApplyAliasSpecificLockModeHints()` Can alias-specific lock modes be applied?
`protected void`	`collectBaselineHints(Map<String,Object> hints)`
`protected void`	`collectHints(Map<String,Object> hints)`
`Type`	`determineProperBooleanType(int position, Object value, Type defaultType)`
`Type`	`determineProperBooleanType(String name, Object value, Type defaultType)`
`protected Type`	`determineType(String namedParam, Class retType)`
`protected int`	`doExecuteUpdate()`
`protected Iterator<R>`	`doIterate()`
`protected List<R>`	`doList()`
`protected ScrollableResultsImplementor`	`doScroll(ScrollMode scrollMode)`
`int`	`executeUpdate()` Execute an update or delete statement.
`CacheMode`	`getCacheMode()` Obtain the CacheMode in effect for this query.
`String`	`getCacheRegion()` Obtain the name of the second level query cache region in which query results will be stored (if they are cached, see the discussion on `Query.isCacheable()` for more information).
`String`	`getComment()` Obtain the comment currently associated with this query.
`protected ExceptionConverter`	`getExceptionConverter()`
`Integer`	`getFetchSize()` Obtain the JDBC fetch size hint in effect for this query.
`int`	`getFirstResult()` The position of the first result the query object was set to retrieve.
`FlushModeType`	`getFlushMode()` Get the flush mode in effect for the query execution.
`FlushMode`	`getHibernateFlushMode()` Obtain the FlushMode in effect for this query.
`Map<String,Object>`	`getHints()` Get the properties and hints and associated values that are in effect for the query instance.
`LockModeType`	`getLockMode()` Get the current lock mode for the query.
`LockOptions`	`getLockOptions()` Obtains the LockOptions in effect for this query.
`int`	`getMaxResults()` The maximum number of results the query object was set to retrieve.
`protected Map<String,TypedValue>`	`getNamedParameterMap()`
`String[]`	`getNamedParameters()` Return the names of all named parameters of the query.
`QueryParameter<?>`	`getParameter(int position)` Get the parameter object corresponding to the declared positional parameter with the given position.
`<T> QueryParameter<T>`	`getParameter(int position, Class<T> type)` Get the parameter object corresponding to the declared positional parameter with the given position and type.
`QueryParameter<?>`	`getParameter(String name)` Get the parameter object corresponding to the declared parameter of the given name.
`<T> QueryParameter<T>`	`getParameter(String name, Class<T> type)` Get the parameter object corresponding to the declared parameter of the given name and type.
`ParameterMetadata`	`getParameterMetadata()` Access to information about query parameters.
`Set<Parameter<?>>`	`getParameters()` Get the parameter objects corresponding to the declared parameters of the query.
`Object`	`getParameterValue(int position)` Return the input value bound to the positional parameter.
`<T> T`	`getParameterValue(Parameter<T> parameter)` Return the input value bound to the parameter.
`Object`	`getParameterValue(String name)` Return the input value bound to the named parameter.
`protected Type[]`	`getPositionalParameterTypes()`
`protected Object[]`	`getPositionalParameterValues()`
`SharedSessionContractImplementor`	`getProducer()` Get the QueryProducer this Query originates from.
`RowSelection`	`getQueryOptions()` "QueryOptions" is a better name, I think, than "RowSelection" -> 6.0
`protected abstract QueryParameterBindings`	`getQueryParameterBindings()`
`QueryParameters`	`getQueryParameters()`
`R`	`getSingleResult()` Execute a SELECT query that returns a single result.
`Set<String>`	`getSupportedHints()`
`Integer`	`getTimeout()` Obtain the query timeout in seconds.
`protected void`	`handleUnrecognizedHint(String hintName, Object value)`
`boolean`	`isBound(Parameter<?> parameter)` Return a boolean indicating whether a value has been bound to the parameter.
`boolean`	`isCacheable()` Are the results of this query eligible for second level query caching? This is different that second level caching of any returned entities and collections.
`protected boolean`	`isCallable()`
`protected abstract boolean`	`isNativeQuery()` Is the query represented here a native (SQL) query?
`boolean`	`isReadOnly()` Should entities and proxies loaded by this Query be put in read-only mode? If the read-only/modifiable setting was not initialized, then the default read-only/modifiable setting for the persistence context is returned instead.
`Iterator<R>`	`iterate()` Return the query results as an `Iterator`.
`List<R>`	`list()` Return the query results as a `List`.
`protected QueryParameters`	`makeQueryParametersForExecution(String hql)`
`protected void`	`putIfNotNull(Map<String,Object> hints, String hintName, Enum hintValue)`
`protected void`	`putIfNotNull(Map<String,Object> hints, String hintName, Object hintValue)`
`protected String`	`resolveEntityName(Object val)`
`ScrollableResultsImplementor`	`scroll()` Return the query results as `ScrollableResults`.
`ScrollableResultsImplementor`	`scroll(ScrollMode scrollMode)` Return the query results as ScrollableResults.
`QueryImplementor`	`setCacheable(boolean cacheable)` Enable/disable second level query (result) caching for this query.
`QueryImplementor`	`setCacheMode(CacheMode cacheMode)` (Re)set the current CacheMode in effect for this query.
`QueryImplementor`	`setCacheRegion(String cacheRegion)` Set the name of the cache region where query results should be cached (if cached at all).
`QueryImplementor`	`setComment(String comment)` Set the comment for this query.
`QueryImplementor`	`setFetchSize(int fetchSize)` Sets a JDBC fetch size hint for the query.
`QueryImplementor`	`setFirstResult(int startPosition)` Set the position of the first result to retrieve.
`QueryImplementor`	`setFlushMode(FlushMode flushMode)` (Re)set the current FlushMode in effect for this query.
`QueryImplementor`	`setFlushMode(FlushModeType flushModeType)` Set the flush mode type to be used for the query execution.
`QueryImplementor`	`setHibernateFlushMode(FlushMode flushMode)` (Re)set the current FlushMode in effect for this query.
`QueryImplementor`	`setHint(String hintName, Object value)` Set a query property or hint.
`QueryImplementor`	`setLockMode(LockModeType lockModeType)` Set the lock mode type to be used for the query execution.
`QueryImplementor`	`setLockMode(String alias, LockMode lockMode)` Set the LockMode to use for specific alias (as defined in the query's `FROM` clause).
`QueryImplementor`	`setLockOptions(LockOptions lockOptions)` Set the lock options for the query.
`QueryImplementor`	`setMaxResults(int maxResult)` Set the maximum number of results to retrieve.
`void`	`setOptionalEntityName(String optionalEntityName)`
`void`	`setOptionalId(Serializable optionalId)`
`void`	`setOptionalObject(Object optionalObject)`
`QueryImplementor`	`setParameter(int position, Calendar value, TemporalType temporalType)` Bind an instance of `java.util.Calendar` to a positional parameter.
`QueryImplementor`	`setParameter(int position, Date value, TemporalType temporalType)` Bind an instance of `java.util.Date` to a positional parameter.
`QueryImplementor<R>`	`setParameter(int position, Instant value, TemporalType temporalType)`
`QueryImplementor<R>`	`setParameter(int position, LocalDateTime value, TemporalType temporalType)`
`QueryImplementor`	`setParameter(int position, Object value)` Bind an argument value to a positional parameter.
`QueryImplementor`	`setParameter(int position, Object value, TemporalType temporalType)` Bind a positional query parameter as some form of date/time using the indicated temporal-type.
`QueryImplementor`	`setParameter(int position, Object value, Type type)` Bind a value to a JDBC-style query parameter.
`QueryImplementor<R>`	`setParameter(int position, OffsetDateTime value, TemporalType temporalType)`
`QueryImplementor<R>`	`setParameter(int position, ZonedDateTime value, TemporalType temporalType)`
`QueryImplementor`	`setParameter(Parameter<Calendar> param, Calendar value, TemporalType temporalType)` Bind an instance of `java.util.Calendar` to a `Parameter` object.
`QueryImplementor`	`setParameter(Parameter<Date> param, Date value, TemporalType temporalType)` Bind an instance of `java.util.Date` to a `Parameter` object.
`QueryImplementor<R>`	`setParameter(Parameter<Instant> param, Instant value, TemporalType temporalType)`
`QueryImplementor<R>`	`setParameter(Parameter<LocalDateTime> param, LocalDateTime value, TemporalType temporalType)`
`QueryImplementor<R>`	`setParameter(Parameter<OffsetDateTime> param, OffsetDateTime value, TemporalType temporalType)`
`<P> QueryImplementor`	`setParameter(Parameter<P> parameter, P value)` Bind the value of a `Parameter` object.
`QueryImplementor<R>`	`setParameter(Parameter<ZonedDateTime> param, ZonedDateTime value, TemporalType temporalType)`
`<P> QueryImplementor`	`setParameter(QueryParameter<P> parameter, P value)` Bind a query parameter using its inferred Type.
`<P> QueryImplementor`	`setParameter(QueryParameter<P> parameter, P value, TemporalType temporalType)` Bind a query parameter as some form of date/time using the indicated temporal-type.
`<P> QueryImplementor`	`setParameter(QueryParameter<P> parameter, P value, Type type)` Bind a query parameter using the supplied Type
`QueryImplementor`	`setParameter(String name, Calendar value, TemporalType temporalType)` Bind an instance of `java.util.Calendar` to a named parameter.
`QueryImplementor`	`setParameter(String name, Date value, TemporalType temporalType)` Bind an instance of `java.util.Date` to a named parameter.
`QueryImplementor<R>`	`setParameter(String name, Instant value, TemporalType temporalType)`
`QueryImplementor<R>`	`setParameter(String name, LocalDateTime value, TemporalType temporalType)`
`QueryImplementor`	`setParameter(String name, Object value)` Bind an argument value to a named parameter.
`QueryImplementor`	`setParameter(String name, Object value, TemporalType temporalType)` Bind a named query parameter as some form of date/time using the indicated temporal-type.
`QueryImplementor`	`setParameter(String name, Object value, Type type)` Bind a named query parameter using the supplied Type
`QueryImplementor<R>`	`setParameter(String name, OffsetDateTime value, TemporalType temporalType)`
`QueryImplementor<R>`	`setParameter(String name, ZonedDateTime value, TemporalType temporalType)`
`QueryImplementor`	`setParameterList(int position, Collection values)`
`QueryImplementor`	`setParameterList(int position, Collection values, Type type)`
`QueryImplementor`	`setParameterList(int position, Object[] values)`
`QueryImplementor`	`setParameterList(int position, Object[] values, Type type)`
`<P> QueryImplementor<R>`	`setParameterList(QueryParameter<P> parameter, Collection<P> values)` Bind multiple values to a query parameter using its inferred Type.
`QueryImplementor`	`setParameterList(String name, Collection values)` Bind multiple values to a named query parameter.
`QueryImplementor`	`setParameterList(String name, Collection values, Type type)` Bind multiple values to a named query parameter.
`QueryImplementor`	`setParameterList(String name, Object[] values)` Bind multiple values to a named query parameter.
`QueryImplementor`	`setParameterList(String name, Object[] values, Type type)` Bind multiple values to a named query parameter.
`QueryImplementor`	`setProperties(Map map)` Bind the values of the given Map for each named parameters of the query, matching key names with parameter names and mapping value types to Hibernate types using heuristics.
`QueryImplementor`	`setProperties(Object bean)` Bind the property values of the given bean to named parameters of the query, matching property names with parameter names and mapping property types to Hibernate types using heuristics.
`QueryImplementor`	`setReadOnly(boolean readOnly)` Set the read-only/modifiable mode for entities and proxies loaded by this Query.
`QueryImplementor`	`setResultTransformer(ResultTransformer transformer)` Set a strategy for handling the query results.
`QueryImplementor`	`setTimeout(int timeout)` Set the query timeout in seconds.
`Stream<R>`	`stream()` Retrieve a Stream over the query results.
`static <R> R`	`uniqueElement(List<R> list)`
`R`	`uniqueResult()` Convenience method to return a single instance that matches the query, or `null` if the query returns no results.
`Optional<R>`	`uniqueResultOptional()`
`<T> T`	`unwrap(Class<T> cls)` Return an object of the specified type to allow access to the provider-specific API.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hibernate.query.Query
getQueryString, getResultList, getResultStream, setBigDecimal, setBigDecimal, setBigInteger, setBigInteger, setBinary, setBinary, setBoolean, setBoolean, setByte, setByte, setCalendar, setCalendar, setCalendarDate, setCalendarDate, setCharacter, setCharacter, setDate, setDate, setDouble, setDouble, setEntity, setEntity, setFloat, setFloat, setInteger, setInteger, setLocale, setLocale, setLong, setLong, setParameters, setSerializable, setSerializable, setShort, setShort, setString, setString, setText, setText, setTime, setTime, setTimestamp, setTimestamp

Methods inherited from interface org.hibernate.Query
getHibernateFirstResult, getHibernateMaxResults, getReturnAliases, getReturnTypes, setHibernateFirstResult, setHibernateMaxResults

- Constructor Detail
 - AbstractProducedQuery
```
public AbstractProducedQuery(SharedSessionContractImplementor producer,
 ParameterMetadata parameterMetadata)
```
- Method Detail
 - getProducer
```
public SharedSessionContractImplementor getProducer()
```
 Description copied from interface: Query
 
 Get the QueryProducer this Query originates from.
 
 Specified by:
 
 getProducer in interface QueryImplementor<R>
 - getHibernateFlushMode
```
public FlushMode getHibernateFlushMode()
```
 Description copied from interface: Query
 
 Obtain the FlushMode in effect for this query. By default, the query inherits the FlushMode of the Session from which it originates.
 
 Specified by:
 
 getHibernateFlushMode in interface BasicQueryContract<CommonQueryContract>
 
 Returns:
 
 The query FlushMode.
 
 See Also:
 
 FlushMode
 - setHibernateFlushMode
```
public QueryImplementor setHibernateFlushMode(FlushMode flushMode)
```
 Description copied from interface: Query
 
 (Re)set the current FlushMode in effect for this query.
 
 Specified by:
 
 setHibernateFlushMode in interface BasicQueryContract<CommonQueryContract>
 
 Parameters:
 
 flushMode - The new FlushMode to use.
 
 Returns:
 
 this, for method chaining
 
 See Also:
 
 Query.getHibernateFlushMode()
 - setFlushMode
```
public QueryImplementor setFlushMode(FlushMode flushMode)
```
 Description copied from interface: Query
 
 (Re)set the current FlushMode in effect for this query.
 
 Specified by:
 
 setFlushMode in interface BasicQueryContract<CommonQueryContract>
 
 Parameters:
 
 flushMode - The new FlushMode to use.
 
 Returns:
 
 this, for method chaining
 
 See Also:
 
 Query.getHibernateFlushMode()
 - getFlushMode
```
public FlushModeType getFlushMode()
```
 Description copied from interface: Query
 
 Get the flush mode in effect for the query execution. If a flush mode has not been set for the query object, returns the flush mode in effect for the entity manager.
 
 Specified by:
 
 getFlushMode in interface Query
 
 Returns:
 
 flush mode
 - setFlushMode
```
public QueryImplementor setFlushMode(FlushModeType flushModeType)
```
 Description copied from interface: TypedQuery
 
 Set the flush mode type to be used for the query execution. The flush mode type applies to the query regardless of the flush mode type in use for the entity manager.
 
 Specified by:
 
 setFlushMode in interface Query
 
 Specified by:
 
 setFlushMode in interface TypedQuery<R>
 
 Parameters:
 
 flushModeType - flush mode
 
 Returns:
 
 the same query instance
 - getCacheMode
```
public CacheMode getCacheMode()
```
 Description copied from interface: Query
 
 Obtain the CacheMode in effect for this query. By default, the query inherits the CacheMode of the Session from which is originates. NOTE: The CacheMode here only effects reading/writing of the query cache, not the entity/collection caches.
 
 Specified by:
 
 getCacheMode in interface BasicQueryContract<CommonQueryContract>
 
 Returns:
 
 The query CacheMode.
 
 See Also:
 
 Session.getCacheMode(), CacheMode
 - setCacheMode
```
public QueryImplementor setCacheMode(CacheMode cacheMode)
```
 Description copied from interface: Query
 
 (Re)set the current CacheMode in effect for this query.
 
 Specified by:
 
 setCacheMode in interface BasicQueryContract<CommonQueryContract>
 
 Parameters:
 
 cacheMode - The new CacheMode to use.
 
 Returns:
 
 this, for method chaining
 
 See Also:
 
 Query.getCacheMode()
 - isCacheable
```
public boolean isCacheable()
```
 Description copied from interface: Query
 
 Are the results of this query eligible for second level query caching? This is different that second level caching of any returned entities and collections. NOTE: the query being "eligible" for caching does not necessarily mean its results will be cached. Second level query caching still has to be enabled on the SessionFactory for this to happen. Usually that is controlled by the hibernate.cache.use_query_cache configuration setting.
 
 Specified by:
 
 isCacheable in interface BasicQueryContract<CommonQueryContract>
 
 Returns:
 
 true if the query results are eligible for caching, false otherwise.
 
 See Also:
 
 AvailableSettings.USE_QUERY_CACHE
 - setCacheable
```
public QueryImplementor setCacheable(boolean cacheable)
```
 Description copied from interface: Query
 
 Enable/disable second level query (result) caching for this query.
 
 Specified by:
 
 setCacheable in interface BasicQueryContract<CommonQueryContract>
 
 Parameters:
 
 cacheable - Should the query results be cacheable?
 
 Returns:
 
 this, for method chaining
 
 See Also:
 
 Query.isCacheable()
 - getCacheRegion
```
public String getCacheRegion()
```
 Description copied from interface: Query
 
 Obtain the name of the second level query cache region in which query results will be stored (if they are cached, see the discussion on Query.isCacheable() for more information). null indicates that the default region should be used.
 
 Specified by:
 
 getCacheRegion in interface BasicQueryContract<CommonQueryContract>
 
 Returns:
 
 The specified cache region name into which query results should be placed; null indicates the default region.
 - setCacheRegion
```
public QueryImplementor setCacheRegion(String cacheRegion)
```
 Description copied from interface: Query
 
 Set the name of the cache region where query results should be cached (if cached at all).
 
 Specified by:
 
 setCacheRegion in interface BasicQueryContract<CommonQueryContract>
 
 Parameters:
 
 cacheRegion - the name of a query cache region, or null to indicate that the default region should be used.
 
 Returns:
 
 this, for method chaining
 
 See Also:
 
 Query.getCacheRegion()
 - getTimeout
```
public Integer getTimeout()
```
 Description copied from interface: Query
 
 Obtain the query timeout in seconds. This value is eventually passed along to the JDBC query via Statement.setQueryTimeout(int). Zero indicates no timeout.
 
 Specified by:
 
 getTimeout in interface BasicQueryContract<CommonQueryContract>
 
 Returns:
 
 The timeout in seconds
 
 See Also:
 
 Statement.getQueryTimeout(), Statement.setQueryTimeout(int)
 - setTimeout
```
public QueryImplementor setTimeout(int timeout)
```
 Description copied from interface: Query
 
 Set the query timeout in seconds. NOTE it is important to understand that any value set here is eventually passed directly through to the JDBC Statement which expressly disallows negative values. So negative values should be avoided as a general rule.
 
 Specified by:
 
 setTimeout in interface BasicQueryContract<CommonQueryContract>
 
 Parameters:
 
 timeout - the timeout in seconds
 
 Returns:
 
 this, for method chaining
 
 See Also:
 
 Query.getTimeout()
 - getFetchSize
```
public Integer getFetchSize()
```
 Description copied from interface: Query
 
 Obtain the JDBC fetch size hint in effect for this query. This value is eventually passed along to the JDBC query via Statement.setFetchSize(int). As defined b y JDBC, this value is a hint to the driver to indicate how many rows to fetch from the database when more rows are needed. NOTE : JDBC expressly defines this value as a hint. It may or may not have any effect on the actual query execution and ResultSet processing depending on the driver.
 
 Specified by:
 
 getFetchSize in interface BasicQueryContract<CommonQueryContract>
 
 Returns:
 
 The timeout in seconds
 
 See Also:
 
 Statement.getFetchSize(), Statement.setFetchSize(int)
 - setFetchSize
```
public QueryImplementor setFetchSize(int fetchSize)
```
 Description copied from interface: Query
 
 Sets a JDBC fetch size hint for the query.
 
 Specified by:
 
 setFetchSize in interface BasicQueryContract<CommonQueryContract>
 
 Parameters:
 
 fetchSize - the fetch size hint
 
 Returns:
 
 this, for method chaining
 
 See Also:
 
 Query.getFetchSize()
 - isReadOnly
```
public boolean isReadOnly()
```
 Description copied from interface: Query
 
 Should entities and proxies loaded by this Query be put in read-only mode? If the read-only/modifiable setting was not initialized, then the default read-only/modifiable setting for the persistence context is returned instead.
 
 Specified by:
 
 isReadOnly in interface BasicQueryContract<CommonQueryContract>
 
 Returns:
 
 true if the entities and proxies loaded by the query will be put in read-only mode; false otherwise (they will be modifiable)
 
 See Also:
 
 Query.setReadOnly(boolean), The read-only/modifiable setting has no impact on entities/proxies returned by the query that existed in the session before the query was executed.
 - setReadOnly
```
public QueryImplementor setReadOnly(boolean readOnly)
```
 Description copied from interface: Query
 
 Set the read-only/modifiable mode for entities and proxies loaded by this Query. This setting overrides the default setting for the persistence context.
 
 Specified by:
 
 setReadOnly in interface BasicQueryContract<CommonQueryContract>
 
 Parameters:
 
 readOnly - true indicates that entities and proxies loaded by the query are to be put in read-only mode; false indicates that entities and proxies loaded by the query will be put in modifiable mode
 
 Returns:
 
 this, for method chaining
 
 See Also:
 
 To set the default read-only/modifiable setting used for entities and proxies that are loaded into the session:, PersistenceContext.setDefaultReadOnly(boolean), Read-only entities are not dirty-checked and snapshots of persistent state are not maintained. Read-only entities can be modified, but changes are not persisted. When a proxy is initialized, the loaded entity will have the same read-only/modifiable setting as the uninitialized proxy has, regardless of the session's current setting. The read-only/modifiable setting has no impact on entities/proxies returned by the query that existed in the session before the query was executed.
 - getLockOptions
```
public LockOptions getLockOptions()
```
 Description copied from interface: Query
 
 Obtains the LockOptions in effect for this query.
 
 Returns:
 
 The LockOptions
 
 See Also:
 
 LockOptions
 - setLockOptions
```
public QueryImplementor setLockOptions(LockOptions lockOptions)
```
 Description copied from interface: Query
 Set the lock options for the query. Specifically only the following are taken into consideration:
 For alias-specific locking, use Query.setLockMode(String, LockMode).
 Parameters:
 
 lockOptions - The lock options to apply to the query.
 
 Returns:
 
 this, for method chaining
 
 See Also:
 
 Query.getLockOptions()
 - setLockMode
```
public QueryImplementor setLockMode(String alias,
 LockMode lockMode)
```
 Description copied from interface: Query
 
 Set the LockMode to use for specific alias (as defined in the query's FROM clause). The alias-specific lock modes specified here are added to the query's internal LockOptions. The effect of these alias-specific LockModes is somewhat dependent on the driver/database in use. Generally speaking, for maximum portability, this method should only be used to mark that the rows corresponding to the given alias should be included in pessimistic locking (LockMode.PESSIMISTIC_WRITE).
 
 Parameters:
 
 alias - a query alias, or "this" for a collection filter
 
 lockMode - The lock mode to apply.
 
 Returns:
 
 this, for method chaining
 
 See Also:
 
 Query.getLockOptions()
 - setLockMode
```
public QueryImplementor setLockMode(LockModeType lockModeType)
```
 Description copied from interface: TypedQuery
 
 Set the lock mode type to be used for the query execution.
 
 Specified by:
 
 setLockMode in interface Query
 
 Specified by:
 
 setLockMode in interface TypedQuery<R>
 
 Parameters:
 
 lockModeType - lock mode
 
 Returns:
 
 the same query instance
 - getComment
```
public String getComment()
```
 Description copied from interface: Query
 
 Obtain the comment currently associated with this query. Provided SQL commenting is enabled (generally by enabling the hibernate.use_sql_comments config setting), this comment will also be added to the SQL query sent to the database. Often useful for identifying the source of troublesome queries on the database side.
 
 Returns:
 
 The comment.
 - setComment
```
public QueryImplementor setComment(String comment)
```
 Description copied from interface: Query
 
 Set the comment for this query.
 
 Parameters:
 
 comment - The human-readable comment
 
 Returns:
 
 this, for method chaining
 
 See Also:
 
 Query.getComment()
 - addQueryHint
```
public QueryImplementor addQueryHint(String hint)
```
 Description copied from interface: Query
 
 Add a DB query hint to the SQL. These differ from JPA's QueryHint, which is specific to the JPA implementation and ignores DB vendor-specific hints. Instead, these are intended solely for the vendor-specific hints, such as Oracle's optimizers. Multiple query hints are supported; the Dialect will determine concatenation and placement.
 
 Parameters:
 
 hint - The database specific query hint to add.
 - getParameterMetadata
```
public ParameterMetadata getParameterMetadata()
```
 Description copied from interface: Query
 
 Access to information about query parameters.
 
 Returns:
 
 information about query parameters.
 - getNamedParameters
```
public String[] getNamedParameters()
```
 Description copied from interface: Query
 
 Return the names of all named parameters of the query.
 
 Returns:
 
 the parameter names, in no particular order
 - setParameter
```
public QueryImplementor<R> setParameter(Parameter<Instant> param,
 Instant value,
 TemporalType temporalType)
```
 - setParameter
```
public QueryImplementor<R> setParameter(Parameter<LocalDateTime> param,
 LocalDateTime value,
 TemporalType temporalType)
```
 - setParameter
```
public QueryImplementor<R> setParameter(Parameter<ZonedDateTime> param,
 ZonedDateTime value,
 TemporalType temporalType)
```
 - setParameter
```
public QueryImplementor<R> setParameter(Parameter<OffsetDateTime> param,
 OffsetDateTime value,
 TemporalType temporalType)
```
 - setParameter
```
public QueryImplementor<R> setParameter(String name,
 Instant value,
 TemporalType temporalType)
```
 - setParameter
```
public QueryImplementor<R> setParameter(String name,
 LocalDateTime value,
 TemporalType temporalType)
```
 - setParameter
```
public QueryImplementor<R> setParameter(String name,
 ZonedDateTime value,
 TemporalType temporalType)
```
 - setParameter
```
public QueryImplementor<R> setParameter(String name,
 OffsetDateTime value,
 TemporalType temporalType)
```
 - setParameter
```
public QueryImplementor<R> setParameter(int position,
 Instant value,
 TemporalType temporalType)
```
 - setParameter
```
public QueryImplementor<R> setParameter(int position,
 LocalDateTime value,
 TemporalType temporalType)
```
 - setParameter
```
public QueryImplementor<R> setParameter(int position,
 ZonedDateTime value,
 TemporalType temporalType)
```
 - setParameter
```
public QueryImplementor<R> setParameter(int position,
 OffsetDateTime value,
 TemporalType temporalType)
```
 - setParameter
```
public  QueryImplementor setParameter(QueryParameter parameter,
 P value)
```
 Description copied from interface: Query
 
 Bind a query parameter using its inferred Type. If the parameter is defined in such a way that the Type cannot be inferred from its usage context then use of this form of binding is not allowed, and Query.setParameter(QueryParameter, Object, Type) should be used instead
 
 Parameters:
 
 parameter - The query parameter memento
 
 value - the possibly-null parameter value
 
 Returns:
 
 this, for method chaining
 - setParameter
```
public  QueryImplementor setParameter(Parameter parameter,
 P value)
```
 Description copied from interface: TypedQuery
 
 Bind the value of a Parameter object.
 
 Specified by:
 
 setParameter in interface Query
 
 Specified by:
 
 setParameter in interface TypedQuery<R>
 
 Parameters:
 
 parameter - parameter object
 
 value - parameter value
 
 Returns:
 
 the same query instance
 - setParameter
```
public QueryImplementor setParameter(String name,
 Object value)
```
 Description copied from interface: TypedQuery
 
 Bind an argument value to a named parameter.
 
 Specified by:
 
 setParameter in interface Query
 
 Specified by:
 
 setParameter in interface TypedQuery<R>
 
 Parameters:
 
 name - parameter name
 
 value - parameter value
 
 Returns:
 
 the same query instance
 - setParameter
```
public QueryImplementor setParameter(int position,
 Object value)
```
 Description copied from interface: TypedQuery
 
 Bind an argument value to a positional parameter.
 
 Specified by:
 
 setParameter in interface Query
 
 Specified by:
 
 setParameter in interface TypedQuery<R>
 
 Parameters:
 
 position - position
 
 value - parameter value
 
 Returns:
 
 the same query instance
 - setParameter
```
public  QueryImplementor setParameter(QueryParameter parameter,
 P value,
 Type type)
```
 Description copied from interface: Query
 
 Bind a query parameter using the supplied Type
 
 Parameters:
 
 parameter - The query parameter memento
 
 value - the possibly-null parameter value
 
 type - the Hibernate type
 
 Returns:
 
 this, for method chaining
 - setParameter
```
public QueryImplementor setParameter(String name,
 Object value,
 Type type)
```
 Description copied from interface: Query
 
 Bind a named query parameter using the supplied Type
 
 Parameters:
 
 name - the name of the parameter
 
 value - the possibly-null parameter value
 
 type - the Hibernate type
 
 Returns:
 
 this, for method chaining
 - setParameter
```
public QueryImplementor setParameter(int position,
 Object value,
 Type type)
```
 Description copied from interface: Query
 
 Bind a value to a JDBC-style query parameter.
 
 Parameters:
 
 position - the position of the parameter in the query string, numbered from 0.
 
 value - the possibly-null parameter value
 
 type - the Hibernate type
 
 Returns:
 
 this, for method chaining
 - setParameter
```
public  QueryImplementor setParameter(QueryParameter parameter,
 P value,
 TemporalType temporalType)
```
 Description copied from interface: Query
 
 Bind a query parameter as some form of date/time using the indicated temporal-type.
 
 Parameters:
 
 parameter - The query parameter memento
 
 value - the possibly-null parameter value
 
 temporalType - the temporal-type to use in binding the date/time
 
 Returns:
 
 this, for method chaining
 - setParameter
```
public QueryImplementor setParameter(String name,
 Object value,
 TemporalType temporalType)
```
 Description copied from interface: Query
 
 Bind a named query parameter as some form of date/time using the indicated temporal-type.
 
 Parameters:
 
 name - the parameter name
 
 value - the possibly-null parameter value
 
 temporalType - the temporal-type to use in binding the date/time
 
 Returns:
 
 this, for method chaining
 - setParameter
```
public QueryImplementor setParameter(int position,
 Object value,
 TemporalType temporalType)
```
 Description copied from interface: Query
 
 Bind a positional query parameter as some form of date/time using the indicated temporal-type.
 
 Parameters:
 
 position - the position of the parameter in the query string, numbered from 0.
 
 value - the possibly-null parameter value
 
 temporalType - the temporal-type to use in binding the date/time
 
 Returns:
 
 this, for method chaining
 - setParameterList
```
public  QueryImplementor<R> setParameterList(QueryParameter parameter,
 Collection values)
```
 Description copied from interface: Query
 
 Bind multiple values to a query parameter using its inferred Type. The Hibernate type of the parameter values is first detected via the usage/position in the query and if not sufficient secondly guessed from the class of the first object in the collection. This is useful for binding a list of values to an expression such as foo.bar in (:value_list).
 
 Parameters:
 
 parameter - the parameter memento
 
 values - a collection of values to list
 
 Returns:
 
 this, for method chaining
 - setParameterList
```
public QueryImplementor setParameterList(String name,
 Collection values)
```
 Description copied from interface: Query
 
 Bind multiple values to a named query parameter. The Hibernate type of the parameter is first detected via the usage/position in the query and if not sufficient secondly guessed from the class of the first object in the collection. This is useful for binding a list of values to an expression such as foo.bar in (:value_list).
 
 Parameters:
 
 name - the name of the parameter
 
 values - a collection of values to list
 
 Returns:
 
 this, for method chaining
 - setParameterList
```
public QueryImplementor setParameterList(int position,
 Collection values)
```
 - setParameterList
```
public QueryImplementor setParameterList(String name,
 Collection values,
 Type type)
```
 Description copied from interface: Query
 
 Bind multiple values to a named query parameter. This is useful for binding a list of values to an expression such as foo.bar in (:value_list).
 
 Parameters:
 
 name - the name of the parameter
 
 values - a collection of values to list
 
 type - the Hibernate type of the values
 
 Returns:
 
 this, for method chaining
 - setParameterList
```
public QueryImplementor setParameterList(int position,
 Collection values,
 Type type)
```
 - setParameterList
```
public QueryImplementor setParameterList(String name,
 Object[] values,
 Type type)
```
 Description copied from interface: Query
 
 Bind multiple values to a named query parameter. This is useful for binding a list of values to an expression such as foo.bar in (:value_list).
 
 Parameters:
 
 name - the name of the parameter
 
 values - a collection of values to list
 
 type - the Hibernate type of the values
 
 Returns:
 
 this, for method chaining
 - setParameterList
```
public QueryImplementor setParameterList(int position,
 Object[] values,
 Type type)
```
 - setParameterList
```
public QueryImplementor setParameterList(String name,
 Object[] values)
```
 Description copied from interface: Query
 
 Bind multiple values to a named query parameter. The Hibernate type of the parameter is first detected via the usage/position in the query and if not sufficient secondly guessed from the class of the first object in the array. This is useful for binding a list of values to an expression such as foo.bar in (:value_list).
 
 Parameters:
 
 name - the name of the parameter
 
 values - a collection of values to list
 
 Returns:
 
 this, for method chaining
 - setParameterList
```
public QueryImplementor setParameterList(int position,
 Object[] values)
```
 - setParameter
```
public QueryImplementor setParameter(Parameter<Calendar> param,
 Calendar value,
 TemporalType temporalType)
```
 Description copied from interface: TypedQuery
 
 Bind an instance of java.util.Calendar to a Parameter object.
 
 Specified by:
 
 setParameter in interface Query
 
 Specified by:
 
 setParameter in interface TypedQuery<R>
 
 Parameters:
 
 param - parameter object
 
 value - parameter value
 
 temporalType - temporal type
 
 Returns:
 
 the same query instance
 - setParameter
```
public QueryImplementor setParameter(Parameter<Date> param,
 Date value,
 TemporalType temporalType)
```
 Description copied from interface: TypedQuery
 
 Bind an instance of java.util.Date to a Parameter object.
 
 Specified by:
 
 setParameter in interface Query
 
 Specified by:
 
 setParameter in interface TypedQuery<R>
 
 Parameters:
 
 param - parameter object
 
 value - parameter value
 
 temporalType - temporal type
 
 Returns:
 
 the same query instance
 - setParameter
```
public QueryImplementor setParameter(String name,
 Calendar value,
 TemporalType temporalType)
```
 Description copied from interface: TypedQuery
 
 Bind an instance of java.util.Calendar to a named parameter.
 
 Specified by:
 
 setParameter in interface Query
 
 Specified by:
 
 setParameter in interface TypedQuery<R>
 
 Parameters:
 
 name - parameter name
 
 value - parameter value
 
 temporalType - temporal type
 
 Returns:
 
 the same query instance
 - setParameter
```
public QueryImplementor setParameter(String name,
 Date value,
 TemporalType temporalType)
```
 Description copied from interface: TypedQuery
 
 Bind an instance of java.util.Date to a named parameter.
 
 Specified by:
 
 setParameter in interface Query
 
 Specified by:
 
 setParameter in interface TypedQuery<R>
 
 Parameters:
 
 name - parameter name
 
 value - parameter value
 
 temporalType - temporal type
 
 Returns:
 
 the same query instance
 - setParameter
```
public QueryImplementor setParameter(int position,
 Calendar value,
 TemporalType temporalType)
```
 Description copied from interface: TypedQuery
 
 Bind an instance of java.util.Calendar to a positional parameter.
 
 Specified by:
 
 setParameter in interface Query
 
 Specified by:
 
 setParameter in interface TypedQuery<R>
 
 Parameters:
 
 position - position
 
 value - parameter value
 
 temporalType - temporal type
 
 Returns:
 
 the same query instance
 - setParameter
```
public QueryImplementor setParameter(int position,
 Date value,
 TemporalType temporalType)
```
 Description copied from interface: TypedQuery
 
 Bind an instance of java.util.Date to a positional parameter.
 
 Specified by:
 
 setParameter in interface Query
 
 Specified by:
 
 setParameter in interface TypedQuery<R>
 
 Parameters:
 
 position - position
 
 value - parameter value
 
 temporalType - temporal type
 
 Returns:
 
 the same query instance
 - getParameters
```
public Set<Parameter<?>> getParameters()
```
 Description copied from interface: Query
 
 Get the parameter objects corresponding to the declared parameters of the query. Returns empty set if the query has no parameters. This method is not required to be supported for native queries.
 
 Specified by:
 
 getParameters in interface Query
 
 Returns:
 
 set of the parameter objects
 - getParameter
```
public QueryParameter<?> getParameter(String name)
```
 Description copied from interface: Query
 
 Get the parameter object corresponding to the declared parameter of the given name. This method is not required to be supported for native queries.
 
 Specified by:
 
 getParameter in interface Query
 
 Parameters:
 
 name - parameter name
 
 Returns:
 
 parameter object
 - getParameter
```
public <T> QueryParameter<T> getParameter(String name,
 Class<T> type)
```
 Description copied from interface: Query
 
 Get the parameter object corresponding to the declared parameter of the given name and type. This method is required to be supported for criteria queries only.
 
 Specified by:
 
 getParameter in interface Query
 
 Parameters:
 
 name - parameter name
 
 type - type
 
 Returns:
 
 parameter object
 - getParameter
```
public QueryParameter<?> getParameter(int position)
```
 Description copied from interface: Query
 
 Get the parameter object corresponding to the declared positional parameter with the given position. This method is not required to be supported for native queries.
 
 Specified by:
 
 getParameter in interface Query
 
 Parameters:
 
 position - position
 
 Returns:
 
 parameter object
 - getParameter
```
public <T> QueryParameter<T> getParameter(int position,
 Class<T> type)
```
 Description copied from interface: Query
 
 Get the parameter object corresponding to the declared positional parameter with the given position and type. This method is not required to be supported by the provider.
 
 Specified by:
 
 getParameter in interface Query
 
 Parameters:
 
 position - position
 
 type - type
 
 Returns:
 
 parameter object
 - isBound
```
public boolean isBound(Parameter<?> parameter)
```
 Description copied from interface: Query
 
 Return a boolean indicating whether a value has been bound to the parameter.
 
 Specified by:
 
 isBound in interface Query
 
 Parameters:
 
 parameter - parameter object
 
 Returns:
 
 boolean indicating whether parameter has been bound
 - getParameterValue
```
public <T> T getParameterValue(Parameter<T> parameter)
```
 Description copied from interface: Query
 
 Return the input value bound to the parameter. (Note that OUT parameters are unbound.)
 
 Specified by:
 
 getParameterValue in interface Query
 
 Parameters:
 
 parameter - parameter object
 
 Returns:
 
 parameter value
 - getParameterValue
```
public Object getParameterValue(String name)
```
 Description copied from interface: Query
 
 Return the input value bound to the named parameter. (Note that OUT parameters are unbound.)
 
 Specified by:
 
 getParameterValue in interface Query
 
 Parameters:
 
 name - parameter name
 
 Returns:
 
 parameter value
 - getParameterValue
```
public Object getParameterValue(int position)
```
 Description copied from interface: Query
 
 Return the input value bound to the positional parameter. (Note that OUT parameters are unbound.)
 
 Specified by:
 
 getParameterValue in interface Query
 
 Parameters:
 
 position - position
 
 Returns:
 
 parameter value
 - setProperties
```
public QueryImplementor setProperties(Object bean)
```
 Description copied from interface: Query
 
 Bind the property values of the given bean to named parameters of the query, matching property names with parameter names and mapping property types to Hibernate types using heuristics.
 
 Parameters:
 
 bean - any JavaBean or POJO
 
 Returns:
 
 this, for method chaining
 - determineType
```
protected Type determineType(String namedParam,
 Class retType)
```
 - setProperties
```
public QueryImplementor setProperties(Map map)
```
 Description copied from interface: Query
 
 Bind the values of the given Map for each named parameters of the query, matching key names with parameter names and mapping value types to Hibernate types using heuristics.
 
 Parameters:
 
 map - a java.util.Map
 
 Returns:
 
 this, for method chaining
 - setResultTransformer
```
public QueryImplementor setResultTransformer(ResultTransformer transformer)
```
 Description copied from interface: Query
 
 Set a strategy for handling the query results. This can be used to change "shape" of the query result.
 
 Parameters:
 
 transformer - The transformer to apply
 
 Returns:
 
 this (for method chaining)
 - getQueryOptions
```
public RowSelection getQueryOptions()
```
 Description copied from interface: Query
 
 "QueryOptions" is a better name, I think, than "RowSelection" -> 6.0
 
 Returns:
 
 Return the encapsulation of this query's options, which includes access to firstRow, maxRows, timeout and fetchSize. Important because this gives access to those values in their Integer form rather than the primitive form (int) required by JPA.
 - getMaxResults
```
public int getMaxResults()
```
 Description copied from interface: Query
 
 The maximum number of results the query object was set to retrieve. Returns Integer.MAX_VALUE if setMaxResults was not applied to the query object.
 
 Specified by:
 
 getMaxResults in interface Query
 
 Returns:
 
 maximum number of results
 - setMaxResults
```
public QueryImplementor setMaxResults(int maxResult)
```
 Description copied from interface: TypedQuery
 
 Set the maximum number of results to retrieve.
 
 Specified by:
 
 setMaxResults in interface Query
 
 Specified by:
 
 setMaxResults in interface TypedQuery<R>
 
 Parameters:
 
 maxResult - maximum number of results to retrieve
 
 Returns:
 
 the same query instance
 - getFirstResult
```
public int getFirstResult()
```
 Description copied from interface: Query
 
 The position of the first result the query object was set to retrieve. Returns 0 if setFirstResult was not applied to the query object.
 
 Specified by:
 
 getFirstResult in interface Query
 
 Returns:
 
 position of the first result
 - setFirstResult
```
public QueryImplementor setFirstResult(int startPosition)
```
 Description copied from interface: TypedQuery
 
 Set the position of the first result to retrieve.
 
 Specified by:
 
 setFirstResult in interface Query
 
 Specified by:
 
 setFirstResult in interface TypedQuery<R>
 
 Parameters:
 
 startPosition - position of the first result, numbered from 0
 
 Returns:
 
 the same query instance
 - getSupportedHints
```
public Set<String> getSupportedHints()
```
 - getHints
```
public Map<String,Object> getHints()
```
 Description copied from interface: Query
 
 Get the properties and hints and associated values that are in effect for the query instance.
 
 Specified by:
 
 getHints in interface Query
 
 Returns:
 
 query properties and hints
 - collectBaselineHints
```
protected void collectBaselineHints(Map<String,Object> hints)
```
 - collectHints
```
protected void collectHints(Map<String,Object> hints)
```
 - putIfNotNull
```
protected void putIfNotNull(Map<String,Object> hints,
 String hintName,
 Enum hintValue)
```
 - putIfNotNull
```
protected void putIfNotNull(Map<String,Object> hints,
 String hintName,
 Object hintValue)
```
 - setHint
```
public QueryImplementor setHint(String hintName,
 Object value)
```
 Description copied from interface: TypedQuery
 
 Set a query property or hint. The hints elements may be used to specify query properties and hints. Properties defined by this specification must be observed by the provider. Vendor-specific hints that are not recognized by a provider must be silently ignored. Portable applications should not rely on the standard timeout hint. Depending on the database in use and the locking mechanisms used by the provider, this hint may or may not be observed.
 
 Specified by:
 
 setHint in interface Query
 
 Specified by:
 
 setHint in interface TypedQuery<R>
 
 Parameters:
 
 hintName - name of property or hint
 
 value - value for the property or hint
 
 Returns:
 
 the same query instance
 - handleUnrecognizedHint
```
protected void handleUnrecognizedHint(String hintName,
 Object value)
```
 - applyJpaCacheRetrieveMode
```
protected boolean applyJpaCacheRetrieveMode(CacheRetrieveMode mode)
```
 - applyJpaCacheStoreMode
```
protected boolean applyJpaCacheStoreMode(CacheStoreMode storeMode)
```
 - applyNativeQueryLockMode
```
protected boolean applyNativeQueryLockMode(Object value)
```
 - applyTimeoutHint
```
protected boolean applyTimeoutHint(int timeout)
```
 Apply the query timeout hint.
 
 Parameters:
 
 timeout - The timeout (in seconds!) specified as a hint
 
 Returns:
 
 true if the hint was "applied"
 - applyLockTimeoutHint
```
protected boolean applyLockTimeoutHint(int timeout)
```
 Apply the lock timeout (in seconds!) hint
 
 Parameters:
 
 timeout - The timeout (in seconds!) specified as a hint
 
 Returns:
 
 true if the hint was "applied"
 - applyCommentHint
```
protected boolean applyCommentHint(String comment)
```
 Apply the comment hint.
 
 Parameters:
 
 comment - The comment specified as a hint
 
 Returns:
 
 true if the hint was "applied"
 - applyFetchSizeHint
```
protected boolean applyFetchSizeHint(int fetchSize)
```
 Apply the fetch size hint
 
 Parameters:
 
 fetchSize - The fetch size specified as a hint
 
 Returns:
 
 true if the hint was "applied"
 - applyCacheableHint
```
protected boolean applyCacheableHint(boolean isCacheable)
```
 Apply the cacheable (true/false) hint.
 
 Parameters:
 
 isCacheable - The value specified as hint
 
 Returns:
 
 true if the hint was "applied"
 - applyCacheRegionHint
```
protected boolean applyCacheRegionHint(String regionName)
```
 Apply the cache region hint
 
 Parameters:
 
 regionName - The name of the cache region specified as a hint
 
 Returns:
 
 true if the hint was "applied"
 - applyReadOnlyHint
```
protected boolean applyReadOnlyHint(boolean isReadOnly)
```
 Apply the read-only (true/false) hint.
 
 Parameters:
 
 isReadOnly - The value specified as hint
 
 Returns:
 
 true if the hint was "applied"
 - applyCacheModeHint
```
protected boolean applyCacheModeHint(CacheMode cacheMode)
```
 Apply the CacheMode hint.
 
 Parameters:
 
 cacheMode - The CacheMode value specified as a hint.
 
 Returns:
 
 true if the hint was "applied"
 - applyFlushModeHint
```
protected boolean applyFlushModeHint(FlushMode flushMode)
```
 Apply the FlushMode hint.
 
 Parameters:
 
 flushMode - The FlushMode value specified as hint
 
 Returns:
 
 true if the hint was "applied"
 - canApplyAliasSpecificLockModeHints
```
protected boolean canApplyAliasSpecificLockModeHints()
```
 Can alias-specific lock modes be applied?
 
 Returns:
 
 true indicates they can be applied, false otherwise.
 - applyLockModeTypeHint
```
protected boolean applyLockModeTypeHint(LockModeType lockModeType)
```
 - applyHibernateLockModeHint
```
protected boolean applyHibernateLockModeHint(LockMode lockMode)
```
 - applyAliasSpecificLockModeHint
```
protected void applyAliasSpecificLockModeHint(String alias,
 LockMode lockMode)
```
 Apply the alias specific lock modes. Assumes canApplyAliasSpecificLockModeHints() has already been called and returned true.
 
 Parameters:
 
 alias - The alias to apply the 'lockMode' to.
 
 lockMode - The LockMode to apply.
 - applyEntityGraphQueryHint
```
protected void applyEntityGraphQueryHint(EntityGraphQueryHint hint)
```
 Used from HEM code as a (hopefully temporary) means to apply a custom query plan in regards to a JPA entity graph.
 
 Parameters:
 
 hint - The entity graph hint object
 - applyFollowOnLockingHint
```
protected boolean applyFollowOnLockingHint(Boolean followOnLocking)
```
 Apply the follow-on-locking hint.
 
 Parameters:
 
 followOnLocking - The follow-on-locking strategy.
 - applyPassDistinctThrough
```
protected boolean applyPassDistinctThrough(boolean passDistinctThrough)
```
 Apply the follow-on-locking hint.
 
 Parameters:
 
 passDistinctThrough - the query passes distinct to the database
 - isNativeQuery
```
protected abstract boolean isNativeQuery()
```
 Is the query represented here a native (SQL) query?
 
 Returns:
 
 true if it is a native query; false otherwise
 - getLockMode
```
public LockModeType getLockMode()
```
 Description copied from interface: Query
 
 Get the current lock mode for the query. Returns null if a lock mode has not been set on the query object.
 
 Specified by:
 
 getLockMode in interface Query
 
 Returns:
 
 lock mode
 - unwrap
```
public <T> T unwrap(Class<T> cls)
```
 Description copied from interface: Query
 
 Return an object of the specified type to allow access to the provider-specific API. If the provider's query implementation does not support the specified class, the PersistenceException is thrown.
 
 Specified by:
 
 unwrap in interface Query
 
 Parameters:
 
 cls - the class of the object to be returned. This is normally either the underlying query implementation class or an interface that it implements.
 
 Returns:
 
 an instance of the specified class
 - makeQueryParametersForExecution
```
protected QueryParameters makeQueryParametersForExecution(String hql)
```
 - getQueryParameters
```
public QueryParameters getQueryParameters()
```
 - getPositionalParameterTypes
```
protected Type[] getPositionalParameterTypes()
```
 - getPositionalParameterValues
```
protected Object[] getPositionalParameterValues()
```
 - getNamedParameterMap
```
protected Map<String,TypedValue> getNamedParameterMap()
```
 - beforeQuery
```
protected void beforeQuery()
```
 - afterQuery
```
protected void afterQuery()
```
 - iterate
```
public Iterator<R> iterate()
```
 Description copied from interface: Query
 
 Return the query results as an Iterator. If the query contains multiple results per row, the results are returned in an instance of Object[].
 
 Entities returned as results are initialized on demand. The first SQL query returns identifiers only.
 
 Returns:
 
 the result iterator
 - doIterate
```
protected Iterator<R> doIterate()
```
 - scroll
```
public ScrollableResultsImplementor scroll()
```
 Description copied from interface: Query
 
 Return the query results as ScrollableResults. The scrollability of the returned results depends upon JDBC driver support for scrollable ResultSets.
 You should call ScrollableResults.close() after processing the ScrollableResults so that the underlying resources are deallocated right away.
 
 Returns:
 
 the result iterator
 
 See Also:
 
 ScrollableResults
 - scroll
```
public ScrollableResultsImplementor scroll(ScrollMode scrollMode)
```
 Description copied from interface: Query
 
 Return the query results as ScrollableResults. The scrollability of the returned results depends upon JDBC driver support for scrollable ResultSets.
 You should call ScrollableResults.close() after processing the ScrollableResults so that the underlying resources are deallocated right away.
 
 Parameters:
 
 scrollMode - The scroll mode
 
 Returns:
 
 the result iterator
 
 See Also:
 
 ScrollableResults, ScrollMode
 - doScroll
```
protected ScrollableResultsImplementor doScroll(ScrollMode scrollMode)
```
 - stream
```
public Stream<R> stream()
```
 Description copied from interface: Query
 
 Retrieve a Stream over the query results.
 In the initial implementation (5.2) this returns a simple sequential Stream. The plan is to return a a smarter stream in 6.x leveraging the SQM model.
 You should call BaseStream.close() after processing the stream so that the underlying resources are deallocated right away.
 
 Returns:
 
 The results Stream
 - uniqueResultOptional
```
public Optional<R> uniqueResultOptional()
```
 - list
```
public List<R> list()
```
 Description copied from interface: Query
 
 Return the query results as a List. If the query contains multiple results per row, the results are returned in an instance of Object[].
 
 Returns:
 
 the result list
 - isCallable
```
protected boolean isCallable()
```
 - doList
```
protected List<R> doList()
```
 - getQueryParameterBindings
```
protected abstract QueryParameterBindings getQueryParameterBindings()
```
 - uniqueResult
```
public R uniqueResult()
```
 Description copied from interface: Query
 
 Convenience method to return a single instance that matches the query, or null if the query returns no results.
 
 Returns:
 
 the single result or null
 - getSingleResult
```
public R getSingleResult()
```
 Description copied from interface: TypedQuery
 
 Execute a SELECT query that returns a single result.
 
 Specified by:
 
 getSingleResult in interface Query
 
 Specified by:
 
 getSingleResult in interface TypedQuery<R>
 
 Returns:
 
 the result
 - uniqueElement
```
public static <R> R uniqueElement(List<R> list)
 throws NonUniqueResultException
```
 Throws:
 
 NonUniqueResultException
 - executeUpdate
```
public int executeUpdate()
 throws HibernateException
```
 Description copied from interface: Query
 
 Execute an update or delete statement.
 
 Specified by:
 
 executeUpdate in interface Query
 
 Returns:
 
 the number of entities updated or deleted
 
 Throws:
 
 HibernateException
 - doExecuteUpdate
```
protected int doExecuteUpdate()
```
 - resolveEntityName
```
protected String resolveEntityName(Object val)
```
 - setOptionalEntityName
```
public void setOptionalEntityName(String optionalEntityName)
```
 Specified by:
 
 setOptionalEntityName in interface QueryImplementor<R>
 - setOptionalId
```
public void setOptionalId(Serializable optionalId)
```
 Specified by:
 
 setOptionalId in interface QueryImplementor<R>
 - setOptionalObject
```
public void setOptionalObject(Object optionalObject)
```
 Specified by:
 
 setOptionalObject in interface QueryImplementor<R>
 - determineProperBooleanType
```
public Type determineProperBooleanType(String name,
 Object value,
 Type defaultType)
```
 - determineProperBooleanType
```
public Type determineProperBooleanType(int position,
 Object value,
 Type defaultType)
```
 - getExceptionConverter
```
protected ExceptionConverter getExceptionConverter()
```

Class AbstractProducedQuery<R>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.hibernate.query.Query

Methods inherited from interface org.hibernate.Query

Constructor Detail

AbstractProducedQuery

Method Detail

getProducer

getHibernateFlushMode

setHibernateFlushMode

setFlushMode

getFlushMode

setFlushMode

getCacheMode

setCacheMode

isCacheable

setCacheable

getCacheRegion

setCacheRegion

getTimeout

setTimeout

getFetchSize

setFetchSize

isReadOnly

setReadOnly

getLockOptions

setLockOptions

setLockMode

setLockMode

getComment

setComment

addQueryHint

getParameterMetadata

getNamedParameters

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

setParameterList

setParameterList

setParameterList

setParameterList

setParameterList

setParameterList

setParameterList

setParameterList

setParameterList

setParameter

setParameter

setParameter

setParameter

setParameter

setParameter

getParameters

getParameter

getParameter

getParameter

getParameter

isBound

getParameterValue