Package org.hibernate.procedure.internal

Class FunctionReturnImpl<T>

java.lang.Object

org.hibernate.procedure.internal.FunctionReturnImpl<T>

All Implemented Interfaces:

Parameter<T>, FunctionReturn<T>, FunctionReturnImplementor<T>, ProcedureParameterImplementor<T>, ProcedureParameter<T>, QueryParameter<T>, QueryParameterImplementor<T>

public class FunctionReturnImpl<T>
extends Object
implements FunctionReturnImplementor<T>

Author:

Steve Ebersole

Constructor Summary

Constructors

Constructor	Description
FunctionReturnImpl(ProcedureCallImplementor<T> procedureCall, int sqlTypeCode)
FunctionReturnImpl(ProcedureCallImplementor<T> procedureCall, OutputableType<T> ormType)

Method Summary

Modifier and Type	Method	Description
boolean	allowsMultiValuedBinding()	Does this parameter allow multi-valued (collection, array, etc) binding?
void	applyAnticipatedType(BindableType type)
void	disallowMultiValuedBinding()
BindableType<T>	getHibernateType()	Get the Hibernate Type associated with this parameter, if one.
int	getJdbcTypeCode()
ParameterMode	getMode()	Retrieves the parameter "mode".
String	getName()	Return the parameter name, or null if the parameter is not a named parameter or no name has been assigned.
Class	getParameterType()	Return the Java type of the parameter.
Integer	getPosition()	Return the parameter position, or null if the parameter is not a positional parameter.
JdbcCallFunctionReturn	toJdbcFunctionReturn(SharedSessionContractImplementor persistenceContext)
NamedCallableQueryMemento.ParameterMemento	toMemento()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.hibernate.procedure.spi.FunctionReturnImplementor

toJdbcParameterRegistration

Constructor Details

FunctionReturnImpl

public FunctionReturnImpl(ProcedureCallImplementor<T> procedureCall,
 int sqlTypeCode)

FunctionReturnImpl

public FunctionReturnImpl(ProcedureCallImplementor<T> procedureCall,
 OutputableType<T> ormType)

Method Details

toJdbcFunctionReturn

public JdbcCallFunctionReturn toJdbcFunctionReturn(SharedSessionContractImplementor persistenceContext)

Specified by:

toJdbcFunctionReturn in interface FunctionReturnImplementor<T>

getJdbcTypeCode

public int getJdbcTypeCode()

Specified by:

getJdbcTypeCode in interface FunctionReturn<T>

getHibernateType

public BindableType<T> getHibernateType()

Description copied from interface: QueryParameter

Get the Hibernate Type associated with this parameter, if one. May return null.

Specified by:

getHibernateType in interface QueryParameter<T>

Returns:

The associated Hibernate Type, may be null.

getName

public String getName()

Description copied from interface: Parameter

Return the parameter name, or null if the parameter is not a named parameter or no name has been assigned.

Specified by:

getName in interface Parameter<T>

Returns:

parameter name

getPosition

public Integer getPosition()

Description copied from interface: Parameter

Return the parameter position, or null if the parameter is not a positional parameter.

Specified by:

getPosition in interface Parameter<T>

Returns:

position of parameter

getMode

public ParameterMode getMode()

Description copied from interface: ProcedureParameter

Retrieves the parameter "mode". Only really pertinent in regards to procedure/function calls. In all other cases the mode would be ParameterMode.IN

Specified by:

getMode in interface ProcedureParameter<T>

Returns:

The parameter mode.

getParameterType

public Class getParameterType()

Description copied from interface: Parameter

Return the Java type of the parameter. Values bound to the parameter must be assignable to this type. This method is required to be supported for criteria queries only. Applications that use this method for Jakarta Persistence query language queries and native queries will not be portable.

Specified by:

getParameterType in interface Parameter<T>

Returns:

the Java type of the parameter

disallowMultiValuedBinding

public void disallowMultiValuedBinding()

Specified by:

disallowMultiValuedBinding in interface QueryParameterImplementor<T>

applyAnticipatedType

public void applyAnticipatedType(BindableType type)

Specified by:

applyAnticipatedType in interface QueryParameterImplementor<T>

allowsMultiValuedBinding

public boolean allowsMultiValuedBinding()

Description copied from interface: QueryParameter

Does this parameter allow multi-valued (collection, array, etc) binding?

This is only valid for HQL/JPQL and (I think) Criteria queries, and is determined based on the context of the parameters declaration.

Specified by:

allowsMultiValuedBinding in interface QueryParameter<T>

Returns:

true indicates that multi-valued binding is allowed for this parameter

toMemento

public NamedCallableQueryMemento.ParameterMemento toMemento()

Specified by:

toMemento in interface QueryParameterImplementor<T>