Package org.hibernate.procedure.spi
Interface ProcedureCallImplementor<R>
-
- All Superinterfaces:
AutoCloseable
,CommonQueryContract
,MutationQuery
,NameableQuery
,ProcedureCall
,jakarta.persistence.Query
,Query<R>
,QueryImplementor<R>
,SelectionQuery<R>
,jakarta.persistence.StoredProcedureQuery
,SynchronizeableQuery
,jakarta.persistence.TypedQuery<R>
- All Known Implementing Classes:
ProcedureCallImpl
public interface ProcedureCallImplementor<R> extends ProcedureCall, QueryImplementor<R>
-
-
Field Summary
-
Fields inherited from interface org.hibernate.procedure.ProcedureCall
FUNCTION_RETURN_TYPE_HINT
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description FunctionReturnImplementor
getFunctionReturn()
ProcedureParameterMetadataImplementor
getParameterMetadata()
Access to information about query parameters.ParameterStrategy
getParameterStrategy()
default List<R>
getResultList()
Execute the query and return the query results as aList
.R
getSingleResult()
Execute the query and return the single result of the query, throwing an exception if the query returns no results.ProcedureCallImplementor<R>
registerStoredProcedureParameter(int position, Class type, jakarta.persistence.ParameterMode mode)
ProcedureCallImplementor<R>
registerStoredProcedureParameter(int position, BasicTypeReference<?> type, jakarta.persistence.ParameterMode mode)
LikeProcedureCall.registerStoredProcedureParameter(int, Class, ParameterMode)
but a basic type reference is given instead of a class for the parameter type.ProcedureCallImplementor<R>
registerStoredProcedureParameter(String parameterName, Class type, jakarta.persistence.ParameterMode mode)
ProcedureCallImplementor<R>
registerStoredProcedureParameter(String parameterName, BasicTypeReference<?> type, jakarta.persistence.ParameterMode mode)
LikeProcedureCall.registerStoredProcedureParameter(String, Class, ParameterMode)
but a basic type reference is given instead of a class for the parameter type.ProcedureCallImplementor<R>
setFlushMode(jakarta.persistence.FlushModeType flushMode)
Set theFlushMode
in to use for this query.ProcedureCallImplementor<R>
setHint(String hintName, Object value)
Apply hints to the query.ProcedureCallImplementor<R>
setParameter(int position, Object value)
Bind the given argument to an ordinal query parameter.ProcedureCallImplementor<R>
setParameter(int position, Calendar value, jakarta.persistence.TemporalType temporalType)
Query
overrideProcedureCallImplementor<R>
setParameter(int position, Date value, jakarta.persistence.TemporalType temporalType)
Query
overrideProcedureCallImplementor<R>
setParameter(jakarta.persistence.Parameter<Calendar> param, Calendar value, jakarta.persistence.TemporalType temporalType)
Query
overrideProcedureCallImplementor<R>
setParameter(jakarta.persistence.Parameter<Date> param, Date value, jakarta.persistence.TemporalType temporalType)
Query
override<T> ProcedureCallImplementor<R>
setParameter(jakarta.persistence.Parameter<T> param, T value)
Query
overrideProcedureCallImplementor<R>
setParameter(String name, Object value)
Bind the given argument to a named query parameter.ProcedureCallImplementor<R>
setParameter(String name, Calendar value, jakarta.persistence.TemporalType temporalType)
Query
overrideProcedureCallImplementor<R>
setParameter(String name, Date value, jakarta.persistence.TemporalType temporalType)
Query
override-
Methods inherited from interface org.hibernate.query.CommonQueryContract
getFlushMode, getHibernateFlushMode, getTimeout
-
Methods inherited from interface org.hibernate.procedure.ProcedureCall
addSynchronizedEntityClass, addSynchronizedEntityName, addSynchronizedQuerySpace, close, getOutputs, getParameterRegistration, getParameterRegistration, getProcedureName, getRegisteredParameters, isFunctionCall, markAsFunctionCall, markAsFunctionCall, markAsFunctionCall, registerParameter, registerParameter, registerParameter, registerParameter, toMemento
-
Methods inherited from interface jakarta.persistence.Query
getFirstResult, getFlushMode, getHints, getLockMode, getMaxResults, getParameter, getParameter, getParameter, getParameter, getParameters, getParameterValue, getParameterValue, getParameterValue, isBound, unwrap
-
Methods inherited from interface org.hibernate.query.Query
addQueryHint, applyFetchGraph, applyGraph, applyLoadGraph, executeUpdate, getComment, getLockOptions, getQueryOptions, getQueryString, getResultStream, list, setCacheable, setCacheMode, setCacheRegion, setCacheRetrieveMode, setCacheStoreMode, setComment, setFetchSize, setFirstResult, setHibernateFlushMode, setLockMode, setLockMode, setLockOptions, setMaxResults, setReadOnly, setTimeout, stream, uniqueResult, uniqueResultOptional
-
Methods inherited from interface org.hibernate.query.spi.QueryImplementor
getParameterBindings, getSession, scroll, scroll, setOptionalEntityName, setOptionalId, setOptionalObject, setParameter, setParameter, setParameter, setParameter, setParameter, setParameter, setParameter, setParameter, setParameter, setParameterList, setParameterList, setParameterList, setParameterList, setParameterList, setParameterList, setParameterList, setParameterList, setParameterList, setParameterList, setParameterList, setParameterList, setParameterList, setParameterList, setParameterList, setParameterList, setParameterList, setParameterList, setProperties, setProperties, setResultListTransformer, setResultTransformer, setTupleTransformer
-
Methods inherited from interface org.hibernate.query.SelectionQuery
getCacheMode, getCacheRegion, getCacheRetrieveMode, getCacheStoreMode, getFetchSize, getFirstResult, getHibernateLockMode, getLockMode, getMaxResults, getSingleResultOrNull, isCacheable, isReadOnly, setAliasSpecificLockMode, setFollowOnLocking, setHibernateLockMode
-
Methods inherited from interface jakarta.persistence.StoredProcedureQuery
execute, executeUpdate, getOutputParameterValue, getOutputParameterValue, getUpdateCount, hasMoreResults
-
Methods inherited from interface org.hibernate.query.SynchronizeableQuery
getSynchronizedQuerySpaces
-
-
-
-
Method Detail
-
getResultList
default List<R> getResultList()
Description copied from interface:Query
Execute the query and return the query results as aList
. If the query contains multiple items in the selection list, then by default each result in the list is packaged in an array of typeObject[]
.- Specified by:
getResultList
in interfacejakarta.persistence.Query
- Specified by:
getResultList
in interfaceQuery<R>
- Specified by:
getResultList
in interfaceSelectionQuery<R>
- Specified by:
getResultList
in interfacejakarta.persistence.StoredProcedureQuery
- Specified by:
getResultList
in interfacejakarta.persistence.TypedQuery<R>
- Returns:
- the results as a list
-
getParameterStrategy
ParameterStrategy getParameterStrategy()
-
getFunctionReturn
FunctionReturnImplementor getFunctionReturn()
-
getParameterMetadata
ProcedureParameterMetadataImplementor getParameterMetadata()
Description copied from interface:Query
Access to information about query parameters.- Specified by:
getParameterMetadata
in interfaceQuery<R>
- Returns:
- information about query parameters.
-
getSingleResult
R getSingleResult()
Description copied from interface:Query
Execute the query and return the single result of the query, throwing an exception if the query returns no results.- Specified by:
getSingleResult
in interfacejakarta.persistence.Query
- Specified by:
getSingleResult
in interfaceQuery<R>
- Specified by:
getSingleResult
in interfaceSelectionQuery<R>
- Specified by:
getSingleResult
in interfacejakarta.persistence.StoredProcedureQuery
- Specified by:
getSingleResult
in interfacejakarta.persistence.TypedQuery<R>
- Returns:
- the single result, only if there is exactly one
-
registerStoredProcedureParameter
ProcedureCallImplementor<R> registerStoredProcedureParameter(int position, BasicTypeReference<?> type, jakarta.persistence.ParameterMode mode)
Description copied from interface:ProcedureCall
LikeProcedureCall.registerStoredProcedureParameter(int, Class, ParameterMode)
but a basic type reference is given instead of a class for the parameter type.- Specified by:
registerStoredProcedureParameter
in interfaceProcedureCall
-
registerStoredProcedureParameter
ProcedureCallImplementor<R> registerStoredProcedureParameter(String parameterName, BasicTypeReference<?> type, jakarta.persistence.ParameterMode mode)
Description copied from interface:ProcedureCall
LikeProcedureCall.registerStoredProcedureParameter(String, Class, ParameterMode)
but a basic type reference is given instead of a class for the parameter type.- Specified by:
registerStoredProcedureParameter
in interfaceProcedureCall
-
setHint
ProcedureCallImplementor<R> setHint(String hintName, Object value)
Description copied from interface:CommonQueryContract
Apply hints to the query.- Specified by:
setHint
in interfaceCommonQueryContract
- Specified by:
setHint
in interfaceProcedureCall
- Specified by:
setHint
in interfacejakarta.persistence.Query
- Specified by:
setHint
in interfaceQuery<R>
- Specified by:
setHint
in interfaceSelectionQuery<R>
- Specified by:
setHint
in interfacejakarta.persistence.StoredProcedureQuery
- Specified by:
setHint
in interfacejakarta.persistence.TypedQuery<R>
-
setParameter
<T> ProcedureCallImplementor<R> setParameter(jakarta.persistence.Parameter<T> param, T value)
Description copied from interface:Query
Query
override- Specified by:
setParameter
in interfaceCommonQueryContract
- Specified by:
setParameter
in interfaceMutationQuery
- Specified by:
setParameter
in interfaceProcedureCall
- Specified by:
setParameter
in interfacejakarta.persistence.Query
- Specified by:
setParameter
in interfaceQuery<R>
- Specified by:
setParameter
in interfaceQueryImplementor<R>
- Specified by:
setParameter
in interfaceSelectionQuery<R>
- Specified by:
setParameter
in interfacejakarta.persistence.StoredProcedureQuery
- Specified by:
setParameter
in interfacejakarta.persistence.TypedQuery<R>
- See Also:
Query.setParameter(Parameter, Object)
-
setParameter
ProcedureCallImplementor<R> setParameter(jakarta.persistence.Parameter<Calendar> param, Calendar value, jakarta.persistence.TemporalType temporalType)
Description copied from interface:Query
Query
override- Specified by:
setParameter
in interfaceCommonQueryContract
- Specified by:
setParameter
in interfaceMutationQuery
- Specified by:
setParameter
in interfaceProcedureCall
- Specified by:
setParameter
in interfacejakarta.persistence.Query
- Specified by:
setParameter
in interfaceQuery<R>
- Specified by:
setParameter
in interfaceQueryImplementor<R>
- Specified by:
setParameter
in interfaceSelectionQuery<R>
- Specified by:
setParameter
in interfacejakarta.persistence.StoredProcedureQuery
- Specified by:
setParameter
in interfacejakarta.persistence.TypedQuery<R>
- See Also:
Query.setParameter(Parameter, Calendar, TemporalType)
-
setParameter
ProcedureCallImplementor<R> setParameter(jakarta.persistence.Parameter<Date> param, Date value, jakarta.persistence.TemporalType temporalType)
Description copied from interface:Query
Query
override- Specified by:
setParameter
in interfaceCommonQueryContract
- Specified by:
setParameter
in interfaceMutationQuery
- Specified by:
setParameter
in interfaceProcedureCall
- Specified by:
setParameter
in interfacejakarta.persistence.Query
- Specified by:
setParameter
in interfaceQuery<R>
- Specified by:
setParameter
in interfaceQueryImplementor<R>
- Specified by:
setParameter
in interfaceSelectionQuery<R>
- Specified by:
setParameter
in interfacejakarta.persistence.StoredProcedureQuery
- Specified by:
setParameter
in interfacejakarta.persistence.TypedQuery<R>
- See Also:
Query.setParameter(Parameter, Date, TemporalType)
-
setParameter
ProcedureCallImplementor<R> setParameter(String name, Object value)
Description copied from interface:CommonQueryContract
Bind the given argument to a named query parameter.If the type of the parameter cannot be inferred from the context in which it occurs, use one of the forms which accepts a "type".
- Specified by:
setParameter
in interfaceCommonQueryContract
- Specified by:
setParameter
in interfaceMutationQuery
- Specified by:
setParameter
in interfaceProcedureCall
- Specified by:
setParameter
in interfacejakarta.persistence.Query
- Specified by:
setParameter
in interfaceQuery<R>
- Specified by:
setParameter
in interfaceQueryImplementor<R>
- Specified by:
setParameter
in interfaceSelectionQuery<R>
- Specified by:
setParameter
in interfacejakarta.persistence.StoredProcedureQuery
- Specified by:
setParameter
in interfacejakarta.persistence.TypedQuery<R>
- See Also:
CommonQueryContract.setParameter(String, Object, Class)
,CommonQueryContract.setParameter(String, Object, BindableType)
-
setParameter
ProcedureCallImplementor<R> setParameter(String name, Calendar value, jakarta.persistence.TemporalType temporalType)
Description copied from interface:Query
Query
override- Specified by:
setParameter
in interfaceCommonQueryContract
- Specified by:
setParameter
in interfaceMutationQuery
- Specified by:
setParameter
in interfaceProcedureCall
- Specified by:
setParameter
in interfacejakarta.persistence.Query
- Specified by:
setParameter
in interfaceQuery<R>
- Specified by:
setParameter
in interfaceQueryImplementor<R>
- Specified by:
setParameter
in interfaceSelectionQuery<R>
- Specified by:
setParameter
in interfacejakarta.persistence.StoredProcedureQuery
- Specified by:
setParameter
in interfacejakarta.persistence.TypedQuery<R>
- See Also:
Query.setParameter(String, Calendar, TemporalType)
-
setParameter
ProcedureCallImplementor<R> setParameter(String name, Date value, jakarta.persistence.TemporalType temporalType)
Description copied from interface:Query
Query
override- Specified by:
setParameter
in interfaceCommonQueryContract
- Specified by:
setParameter
in interfaceMutationQuery
- Specified by:
setParameter
in interfaceProcedureCall
- Specified by:
setParameter
in interfacejakarta.persistence.Query
- Specified by:
setParameter
in interfaceQuery<R>
- Specified by:
setParameter
in interfaceQueryImplementor<R>
- Specified by:
setParameter
in interfaceSelectionQuery<R>
- Specified by:
setParameter
in interfacejakarta.persistence.StoredProcedureQuery
- Specified by:
setParameter
in interfacejakarta.persistence.TypedQuery<R>
- See Also:
Query.setParameter(String, Date, TemporalType)
-
setParameter
ProcedureCallImplementor<R> setParameter(int position, Object value)
Description copied from interface:CommonQueryContract
Bind the given argument to an ordinal query parameter.If the type of the parameter cannot be inferred from the context in which it occurs, use one of the forms which accepts a "type".
- Specified by:
setParameter
in interfaceCommonQueryContract
- Specified by:
setParameter
in interfaceMutationQuery
- Specified by:
setParameter
in interfaceProcedureCall
- Specified by:
setParameter
in interfacejakarta.persistence.Query
- Specified by:
setParameter
in interfaceQuery<R>
- Specified by:
setParameter
in interfaceQueryImplementor<R>
- Specified by:
setParameter
in interfaceSelectionQuery<R>
- Specified by:
setParameter
in interfacejakarta.persistence.StoredProcedureQuery
- Specified by:
setParameter
in interfacejakarta.persistence.TypedQuery<R>
- See Also:
CommonQueryContract.setParameter(int, Object, Class)
,CommonQueryContract.setParameter(int, Object, BindableType)
-
setParameter
ProcedureCallImplementor<R> setParameter(int position, Calendar value, jakarta.persistence.TemporalType temporalType)
Description copied from interface:Query
Query
override- Specified by:
setParameter
in interfaceCommonQueryContract
- Specified by:
setParameter
in interfaceMutationQuery
- Specified by:
setParameter
in interfaceProcedureCall
- Specified by:
setParameter
in interfacejakarta.persistence.Query
- Specified by:
setParameter
in interfaceQuery<R>
- Specified by:
setParameter
in interfaceQueryImplementor<R>
- Specified by:
setParameter
in interfaceSelectionQuery<R>
- Specified by:
setParameter
in interfacejakarta.persistence.StoredProcedureQuery
- Specified by:
setParameter
in interfacejakarta.persistence.TypedQuery<R>
- See Also:
Query.setParameter(int, Calendar, TemporalType)
-
setParameter
ProcedureCallImplementor<R> setParameter(int position, Date value, jakarta.persistence.TemporalType temporalType)
Description copied from interface:Query
Query
override- Specified by:
setParameter
in interfaceCommonQueryContract
- Specified by:
setParameter
in interfaceMutationQuery
- Specified by:
setParameter
in interfaceProcedureCall
- Specified by:
setParameter
in interfacejakarta.persistence.Query
- Specified by:
setParameter
in interfaceQuery<R>
- Specified by:
setParameter
in interfaceQueryImplementor<R>
- Specified by:
setParameter
in interfaceSelectionQuery<R>
- Specified by:
setParameter
in interfacejakarta.persistence.StoredProcedureQuery
- Specified by:
setParameter
in interfacejakarta.persistence.TypedQuery<R>
- See Also:
Query.setParameter(int, Date, TemporalType)
-
setFlushMode
ProcedureCallImplementor<R> setFlushMode(jakarta.persistence.FlushModeType flushMode)
Description copied from interface:CommonQueryContract
Set theFlushMode
in to use for this query.- Specified by:
setFlushMode
in interfaceCommonQueryContract
- Specified by:
setFlushMode
in interfaceProcedureCall
- Specified by:
setFlushMode
in interfacejakarta.persistence.Query
- Specified by:
setFlushMode
in interfaceQuery<R>
- Specified by:
setFlushMode
in interfaceSelectionQuery<R>
- Specified by:
setFlushMode
in interfacejakarta.persistence.StoredProcedureQuery
- Specified by:
setFlushMode
in interfacejakarta.persistence.TypedQuery<R>
- See Also:
CommonQueryContract.getHibernateFlushMode()
,Session.getHibernateFlushMode()
-
registerStoredProcedureParameter
ProcedureCallImplementor<R> registerStoredProcedureParameter(int position, Class type, jakarta.persistence.ParameterMode mode)
- Specified by:
registerStoredProcedureParameter
in interfaceProcedureCall
- Specified by:
registerStoredProcedureParameter
in interfacejakarta.persistence.StoredProcedureQuery
-
registerStoredProcedureParameter
ProcedureCallImplementor<R> registerStoredProcedureParameter(String parameterName, Class type, jakarta.persistence.ParameterMode mode)
- Specified by:
registerStoredProcedureParameter
in interfaceProcedureCall
- Specified by:
registerStoredProcedureParameter
in interfacejakarta.persistence.StoredProcedureQuery
-
-