Package org.datanucleus.api.jakarta

Class JakartaStoredProcedureQuery

java.lang.Object

org.datanucleus.api.jakarta.JakartaQuery

org.datanucleus.api.jakarta.JakartaStoredProcedureQuery

All Implemented Interfaces:

jakarta.persistence.Query, jakarta.persistence.StoredProcedureQuery, jakarta.persistence.TypedQuery

public class JakartaStoredProcedureQuery
extends JakartaQuery
implements jakarta.persistence.StoredProcedureQuery

Implementation of a StoredProcedureQuery. Wraps an internal query.

Field Summary

Fields inherited from class org.datanucleus.api.jakarta.JakartaQuery

QUERY_HINT_FETCH_SIZE, QUERY_HINT_IGNORE_CACHE, QUERY_HINT_TIMEOUT

Constructor Summary

Constructors

Constructor	Description
JakartaStoredProcedureQuery(jakarta.persistence.EntityManager em, org.datanucleus.store.query.Query query)

Method Summary

Modifier and Type	Method	Description
boolean	execute()
int	executeUpdate()	Method to execute a (UPDATE/DELETE) query returning the number of changed records.
Object	getOutputParameterValue(int position)
Object	getOutputParameterValue(String parameterName)
List	getResultList()	Method to execute a (SELECT) query statement returning multiple results.
Object	getSingleResult()	Method to execute a SELECT statement returning a single result.
int	getUpdateCount()
boolean	hasMoreResults()
jakarta.persistence.StoredProcedureQuery	registerStoredProcedureParameter(int position, Class type, jakarta.persistence.ParameterMode mode)
jakarta.persistence.StoredProcedureQuery	registerStoredProcedureParameter(String parameterName, Class type, jakarta.persistence.ParameterMode mode)
JakartaStoredProcedureQuery	setFlushMode(jakarta.persistence.FlushModeType mode)	Mutator for the flush mode.
JakartaStoredProcedureQuery	setHint(String hintName, Object value)	Method to add a vendor extension to the query.
JakartaStoredProcedureQuery	setParameter(int position, Object value)	Bind an argument to a positional parameter.
JakartaStoredProcedureQuery	setParameter(int position, Calendar value, jakarta.persistence.TemporalType temporalType)	Bind an instance of java.util.Calendar to a positional parameter.
JakartaStoredProcedureQuery	setParameter(int position, Date value, jakarta.persistence.TemporalType temporalType)	Bind an instance of java.util.Date to a positional parameter.
JakartaStoredProcedureQuery	setParameter(jakarta.persistence.Parameter param, Object value)	Bind the value of a Parameter object.
JakartaStoredProcedureQuery	setParameter(jakarta.persistence.Parameter param, Calendar cal, jakarta.persistence.TemporalType type)
JakartaStoredProcedureQuery	setParameter(jakarta.persistence.Parameter param, Date date, jakarta.persistence.TemporalType type)
JakartaStoredProcedureQuery	setParameter(String name, Object value)	Bind an argument to a named parameter.
JakartaStoredProcedureQuery	setParameter(String name, Calendar value, jakarta.persistence.TemporalType temporalType)	Bind an instance of java.util.Calendar to a named parameter.
JakartaStoredProcedureQuery	setParameter(String name, Date date, jakarta.persistence.TemporalType type)	Bind an instance of java.util.Date to a named parameter.

Methods inherited from class org.datanucleus.api.jakarta.JakartaQuery

getFetchPlan, getFirstResult, getFlushMode, getHints, getInternalQuery, getLanguage, getLockMode, getMaxResults, getNativeQuery, getParameter, getParameter, getParameter, getParameter, getParameters, getParameterValue, getParameterValue, getParameterValue, getSupportedHints, isBound, isNativeQuery, loadParameters, loadParametersForCompilation, saveAsNamedQuery, setFirstResult, setLockMode, setMaxResults, toString, unwrap

Methods inherited from class java.lang.Object

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

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 jakarta.persistence.TypedQuery

getResultStream

Constructor Detail

JakartaStoredProcedureQuery

public JakartaStoredProcedureQuery(jakarta.persistence.EntityManager em,
                                   org.datanucleus.store.query.Query query)

Method Detail

setParameter

public JakartaStoredProcedureQuery setParameter(jakarta.persistence.Parameter param,
                                                Object value)

Description copied from class: JakartaQuery

Bind the value of a Parameter object.

Specified by:

setParameter in interface jakarta.persistence.Query

Specified by:

setParameter in interface jakarta.persistence.StoredProcedureQuery

Specified by:

setParameter in interface jakarta.persistence.TypedQuery

Overrides:

setParameter in class JakartaQuery

Parameters:

param - parameter to be set

value - parameter value

Returns:

query instance

setParameter

public JakartaStoredProcedureQuery setParameter(jakarta.persistence.Parameter param,
                                                Calendar cal,
                                                jakarta.persistence.TemporalType type)

Specified by:

setParameter in interface jakarta.persistence.Query

Specified by:

setParameter in interface jakarta.persistence.StoredProcedureQuery

Specified by:

setParameter in interface jakarta.persistence.TypedQuery

Overrides:

setParameter in class JakartaQuery

setParameter

public JakartaStoredProcedureQuery setParameter(jakarta.persistence.Parameter param,
                                                Date date,
                                                jakarta.persistence.TemporalType type)

Specified by:

setParameter in interface jakarta.persistence.Query

Specified by:

setParameter in interface jakarta.persistence.StoredProcedureQuery

Specified by:

setParameter in interface jakarta.persistence.TypedQuery

Overrides:

setParameter in class JakartaQuery

setParameter

public JakartaStoredProcedureQuery setParameter(String name,
                                                Object value)

Description copied from class: JakartaQuery

Bind an argument to a named parameter.

Specified by:

setParameter in interface jakarta.persistence.Query

Specified by:

setParameter in interface jakarta.persistence.StoredProcedureQuery

Specified by:

setParameter in interface jakarta.persistence.TypedQuery

Overrides:

setParameter in class JakartaQuery

Parameters:

name - the parameter name

value - The value for the param

Returns:

the same query instance

setParameter

public JakartaStoredProcedureQuery setParameter(String name,
                                                Calendar value,
                                                jakarta.persistence.TemporalType temporalType)

Description copied from class: JakartaQuery

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

Specified by:

setParameter in interface jakarta.persistence.Query

Specified by:

setParameter in interface jakarta.persistence.StoredProcedureQuery

Specified by:

setParameter in interface jakarta.persistence.TypedQuery

Overrides:

setParameter in class JakartaQuery

Parameters:

name - name of the param

value - Value for the param

temporalType - The temporal type

Returns:

the same query instance

setParameter

public JakartaStoredProcedureQuery setParameter(String name,
                                                Date date,
                                                jakarta.persistence.TemporalType type)

Description copied from class: JakartaQuery

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

Specified by:

setParameter in interface jakarta.persistence.Query

Specified by:

setParameter in interface jakarta.persistence.StoredProcedureQuery

Specified by:

setParameter in interface jakarta.persistence.TypedQuery

Overrides:

setParameter in class JakartaQuery

Parameters:

name - Name of the param

date - Value for the param

type - The temporal type

Returns:

the same query instance

setParameter

public JakartaStoredProcedureQuery setParameter(int position,
                                                Object value)

Description copied from class: JakartaQuery

Bind an argument to a positional parameter.

Specified by:

setParameter in interface jakarta.persistence.Query

Specified by:

setParameter in interface jakarta.persistence.StoredProcedureQuery

Specified by:

setParameter in interface jakarta.persistence.TypedQuery

Overrides:

setParameter in class JakartaQuery

Parameters:

position - Parameter position

value - The value

Returns:

the same query instance

setParameter

public JakartaStoredProcedureQuery setParameter(int position,
                                                Calendar value,
                                                jakarta.persistence.TemporalType temporalType)

Description copied from class: JakartaQuery

Bind an instance of java.util.Calendar to a positional parameter.

Specified by:

setParameter in interface jakarta.persistence.Query

Specified by:

setParameter in interface jakarta.persistence.StoredProcedureQuery

Specified by:

setParameter in interface jakarta.persistence.TypedQuery

Overrides:

setParameter in class JakartaQuery

Parameters:

position - Parameter position

value - Value for the param

temporalType - Temporal type

Returns:

the same query instance

setParameter

public JakartaStoredProcedureQuery setParameter(int position,
                                                Date value,
                                                jakarta.persistence.TemporalType temporalType)

Description copied from class: JakartaQuery

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

Specified by:

setParameter in interface jakarta.persistence.Query

Specified by:

setParameter in interface jakarta.persistence.StoredProcedureQuery

Specified by:

setParameter in interface jakarta.persistence.TypedQuery

Overrides:

setParameter in class JakartaQuery

Parameters:

position - Parameter position

value - Value for the param

temporalType - Temporal Type

Returns:

the same query instance

registerStoredProcedureParameter

public jakarta.persistence.StoredProcedureQuery registerStoredProcedureParameter(int position,
                                                                                 Class type,
                                                                                 jakarta.persistence.ParameterMode mode)

Specified by:

registerStoredProcedureParameter in interface jakarta.persistence.StoredProcedureQuery

registerStoredProcedureParameter

public jakarta.persistence.StoredProcedureQuery registerStoredProcedureParameter(String parameterName,
                                                                                 Class type,
                                                                                 jakarta.persistence.ParameterMode mode)

Specified by:

registerStoredProcedureParameter in interface jakarta.persistence.StoredProcedureQuery

getOutputParameterValue

public Object getOutputParameterValue(int position)

Specified by:

getOutputParameterValue in interface jakarta.persistence.StoredProcedureQuery

getOutputParameterValue

public Object getOutputParameterValue(String parameterName)

Specified by:

getOutputParameterValue in interface jakarta.persistence.StoredProcedureQuery

execute

public boolean execute()

Specified by:

execute in interface jakarta.persistence.StoredProcedureQuery

hasMoreResults

public boolean hasMoreResults()

Specified by:

hasMoreResults in interface jakarta.persistence.StoredProcedureQuery

getUpdateCount

public int getUpdateCount()

Specified by:

getUpdateCount in interface jakarta.persistence.StoredProcedureQuery

executeUpdate

public int executeUpdate()

Description copied from class: JakartaQuery

Method to execute a (UPDATE/DELETE) query returning the number of changed records.

Specified by:

executeUpdate in interface jakarta.persistence.Query

Specified by:

executeUpdate in interface jakarta.persistence.StoredProcedureQuery

Overrides:

executeUpdate in class JakartaQuery

Returns:

Number of records updated/deleted with the query.

getResultList

public List getResultList()

Description copied from class: JakartaQuery

Method to execute a (SELECT) query statement returning multiple results.

Specified by:

getResultList in interface jakarta.persistence.Query

Specified by:

getResultList in interface jakarta.persistence.StoredProcedureQuery

Specified by:

getResultList in interface jakarta.persistence.TypedQuery

Overrides:

getResultList in class JakartaQuery

Returns:

The results

getSingleResult

public Object getSingleResult()

Description copied from class: JakartaQuery

Method to execute a SELECT statement returning a single result.

Specified by:

getSingleResult in interface jakarta.persistence.Query

Specified by:

getSingleResult in interface jakarta.persistence.StoredProcedureQuery

Specified by:

getSingleResult in interface jakarta.persistence.TypedQuery

Overrides:

getSingleResult in class JakartaQuery

Returns:

the result

setFlushMode

public JakartaStoredProcedureQuery setFlushMode(jakarta.persistence.FlushModeType mode)

Description copied from class: JakartaQuery

Mutator for the flush mode.

Specified by:

setFlushMode in interface jakarta.persistence.Query

Specified by:

setFlushMode in interface jakarta.persistence.StoredProcedureQuery

Specified by:

setFlushMode in interface jakarta.persistence.TypedQuery

Overrides:

setFlushMode in class JakartaQuery

Parameters:

mode - Flush mode

Returns:

The query

setHint

public JakartaStoredProcedureQuery setHint(String hintName,
                                           Object value)

Description copied from class: JakartaQuery

Method to add a vendor extension to the query. If the hint name is not recognized, it is silently ignored.

Specified by:

setHint in interface jakarta.persistence.Query

Specified by:

setHint in interface jakarta.persistence.StoredProcedureQuery

Specified by:

setHint in interface jakarta.persistence.TypedQuery

Overrides:

setHint in class JakartaQuery

Parameters:

hintName - Name of the "hint"

value - Value for the "hint"

Returns:

the same query instance