javax.persistence.jpa21

Interface StoredProcedureQuery

All Superinterfaces:

javax.persistence.Query

All Known Implementing Classes:

JPAStoredProcedureQuery

public interface StoredProcedureQuery
extends javax.persistence.Query

Interface used to control stored procedure query execution.

Since:

Java Persistence 2.1

See Also:

Query, Parameter

Method Summary

Methods

Modifier and Type	Method and Description
boolean	execute() Returns true if the first result corresponds to a result set, and false if it is an update count or if there are no results other than through INOUT and OUT parameters, if any.
Object	getOutputParameterValue(int position) Used to retrieve the values passed back from the procedure through INOUT and OUT parameters.
Object	getOutputParameterValue(String parameterName) Used to retrieve the values passed back from the procedure through INOUT and OUT parameters.
int	getUpdateCount() Returns the update count or -1 if there is no pending result or if the next result is not an update count.
boolean	hasMoreResults() Returns true if the next result corresponds to a result set, and false if it is an update count or if there are no results other than through INOUT and OUT parameters, if any.
StoredProcedureQuery	registerStoredProcedureParameter(int position, Class type, ParameterMode mode) Register a positional parameter.
StoredProcedureQuery	registerStoredProcedureParameter(String parameterName, Class type, ParameterMode mode) Register a named parameter.
StoredProcedureQuery	setFlushMode(javax.persistence.FlushModeType flushMode) Set the flush mode type to be used for the query execution.
StoredProcedureQuery	setHint(String hintName, Object value) Set a query property or hint.
StoredProcedureQuery	setParameter(int position, Calendar value, javax.persistence.TemporalType temporalType) Bind an instance of java.util.Calendar to a positional parameter.
StoredProcedureQuery	setParameter(int position, Date value, javax.persistence.TemporalType temporalType) Bind an instance of java.util.Date to a positional parameter.
StoredProcedureQuery	setParameter(int position, Object value) Bind an argument to a positional parameter.
StoredProcedureQuery	setParameter(javax.persistence.Parameter<Calendar> param, Calendar value, javax.persistence.TemporalType temporalType) Bind an instance of java.util.Calendar to a Parameter object.
StoredProcedureQuery	setParameter(javax.persistence.Parameter<Date> param, Date value, javax.persistence.TemporalType temporalType) Bind an instance of java.util.Date to a Parameter object.
<T> StoredProcedureQuery	setParameter(javax.persistence.Parameter<T> param, T value) Bind the value of a Parameter object.
StoredProcedureQuery	setParameter(String name, Calendar value, javax.persistence.TemporalType temporalType) Bind an instance of java.util.Calendar to a named parameter.
StoredProcedureQuery	setParameter(String name, Date value, javax.persistence.TemporalType temporalType) Bind an instance of java.util.Date to a named parameter.
StoredProcedureQuery	setParameter(String name, Object value) Bind an argument to a named parameter.

Methods inherited from interface javax.persistence.Query

executeUpdate, getFirstResult, getFlushMode, getHints, getLockMode, getMaxResults, getParameter, getParameter, getParameter, getParameter, getParameters, getParameterValue, getParameterValue, getParameterValue, getResultList, getSingleResult, isBound, setFirstResult, setLockMode, setMaxResults, unwrap

Method Detail

setHint

StoredProcedureQuery setHint(String hintName,
                           Object value)

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, this hint may or may not be observed.

Specified by:

setHint in interface javax.persistence.Query

Parameters:

hintName - name of the property or hint

value - value for the property or hint

Returns:

the same query instance

Throws:

IllegalArgumentException - if the second argument is not valid for the implementation

setParameter

<T> StoredProcedureQuery setParameter(javax.persistence.Parameter<T> param,
                                    T value)

Bind the value of a Parameter object.

Specified by:

setParameter in interface javax.persistence.Query

Parameters:

param - parameter object

value - parameter value

Returns:

the same query instance

Throws:

IllegalArgumentException - if the parameter does not correspond to a parameter of the query

setParameter

StoredProcedureQuery setParameter(javax.persistence.Parameter<Calendar> param,
                                Calendar value,
                                javax.persistence.TemporalType temporalType)

Bind an instance of java.util.Calendar to a Parameter object.

Specified by:

setParameter in interface javax.persistence.Query

Parameters:

param - parameter object

value - parameter value

temporalType - temporal type

Returns:

the same query instance

Throws:

IllegalArgumentException - if the parameter does not correspond to a parameter of the query

setParameter

StoredProcedureQuery setParameter(javax.persistence.Parameter<Date> param,
                                Date value,
                                javax.persistence.TemporalType temporalType)

Bind an instance of java.util.Date to a Parameter object.

Specified by:

setParameter in interface javax.persistence.Query

Parameters:

param - parameter object

value - parameter value

temporalType - temporal type

Returns:

the same query instance

Throws:

IllegalArgumentException - if the parameter does not correspond to a parameter of the query

setParameter

StoredProcedureQuery setParameter(String name,
                                Object value)

Bind an argument to a named parameter.

Specified by:

setParameter in interface javax.persistence.Query

Parameters:

name - parameter name

value - parameter value

Returns:

the same query instance

Throws:

IllegalArgumentException - if the parameter name does not correspond to a parameter of the query or if the argument is of incorrect type

setParameter

StoredProcedureQuery setParameter(String name,
                                Calendar value,
                                javax.persistence.TemporalType temporalType)

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

Specified by:

setParameter in interface javax.persistence.Query

Parameters:

name - parameter name

value - parameter value

temporalType - temporal type

Returns:

the same query instance

Throws:

IllegalArgumentException - if the parameter name does not correspond to a parameter of the query or if the value argument is of incorrect type

setParameter

StoredProcedureQuery setParameter(String name,
                                Date value,
                                javax.persistence.TemporalType temporalType)

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

Specified by:

setParameter in interface javax.persistence.Query

Parameters:

name - parameter name

value - parameter value

temporalType - temporal type

Returns:

the same query instance

Throws:

IllegalArgumentException - if the parameter name does not correspond to a parameter of the query or if the value argument is of incorrect type

setParameter

StoredProcedureQuery setParameter(int position,
                                Object value)

Bind an argument to a positional parameter.

Specified by:

setParameter in interface javax.persistence.Query

Parameters:

position - position

value - parameter value

Returns:

the same query instance

Throws:

IllegalArgumentException - if position does not correspond to a positional parameter of the query or if the argument is of incorrect type

setParameter

StoredProcedureQuery setParameter(int position,
                                Calendar value,
                                javax.persistence.TemporalType temporalType)

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

Specified by:

setParameter in interface javax.persistence.Query

Parameters:

position - position

value - parameter value

temporalType - temporal type

Returns:

the same query instance

Throws:

IllegalArgumentException - if position does not correspond to a positional parameter of the query or if the value argument is of incorrect type

setParameter

StoredProcedureQuery setParameter(int position,
                                Date value,
                                javax.persistence.TemporalType temporalType)

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

Specified by:

setParameter in interface javax.persistence.Query

Parameters:

position - position

value - parameter value

temporalType - temporal type

Returns:

the same query instance

Throws:

IllegalArgumentException - if position does not correspond to a positional parameter of the query or if the value argument is of incorrect type

setFlushMode

StoredProcedureQuery setFlushMode(javax.persistence.FlushModeType flushMode)

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 javax.persistence.Query

Parameters:

flushMode - flush mode

Returns:

the same query instance

registerStoredProcedureParameter

StoredProcedureQuery registerStoredProcedureParameter(int position,
                                                    Class type,
                                                    ParameterMode mode)

Register a positional parameter. All positional parameters must be registered.

Parameters:

position - parameter position

type - type of the parameter

mode - parameter mode

Returns:

the same query instance

registerStoredProcedureParameter

StoredProcedureQuery registerStoredProcedureParameter(String parameterName,
                                                    Class type,
                                                    ParameterMode mode)

Register a named parameter. When using parameter names, all parameters must be registered in the order in which they occur in the parameter list of the stored procedure.

Parameters:

parameterName - name of the parameter as registered or specified in metadata

type - type of the parameter

mode - parameter mode

Returns:

the same query instance

getOutputParameterValue

Object getOutputParameterValue(int position)

Used to retrieve the values passed back from the procedure through INOUT and OUT parameters. For portability, all results corresponding to result sets and update counts must be retrieved before the values of output parameters.

Parameters:

position - parameter position

Returns:

the result that is passed back through the parameter

Throws:

IllegalArgumentException - if the position does not correspond to a parameter of the query or is not an INOUT or OUT parameter

getOutputParameterValue

Object getOutputParameterValue(String parameterName)

Used to retrieve the values passed back from the procedure through INOUT and OUT parameters. For portability, all results corresponding to result sets and update counts must be retrieved before the values of output parameters.

Parameters:

parameterName - name of the parameter as registered or specified in metadata

Returns:

the result that is passed back through the parameter

Throws:

IllegalArgumentException - if the parameter name does not correspond to a parameter of the query or is not an INOUT or OUT parameter

execute

boolean execute()

Returns true if the first result corresponds to a result set, and false if it is an update count or if there are no results other than through INOUT and OUT parameters, if any.

Returns:

true if first result corresponds to result set

Throws:

javax.persistence.QueryTimeoutException - if the query execution exceeds the query timeout value set and only the statement is rolled back

javax.persistence.PersistenceException - if the query execution exceeds the query timeout value set and the transaction is rolled back

hasMoreResults

boolean hasMoreResults()

Returns true if the next result corresponds to a result set, and false if it is an update count or if there are no results other than through INOUT and OUT parameters, if any.

Returns:

true if next result corresponds to result set

Throws:

javax.persistence.QueryTimeoutException - if the query execution exceeds the query timeout value set and only the statement is rolled back

javax.persistence.PersistenceException - if the query execution exceeds the query timeout value set and the transaction is rolled back

getUpdateCount

int getUpdateCount()

Returns the update count or -1 if there is no pending result or if the next result is not an update count.

Returns:

update count or -1 if there is no pending result or if the next result is not an update count

Throws:

javax.persistence.QueryTimeoutException - if the query execution exceeds the query timeout value set and only the statement is rolled back

javax.persistence.PersistenceException - if the query execution exceeds the query timeout value set and the transaction is rolled back