207 words

javax.persistence.Parameter - JPA interface

javax.persistence
Interface Parameter<T>

Subinterfaces:
ParameterExpression
Type for query parameter objects.
Since:
JPA 2.0
See Also:
Query
TypedQuery
Learn how to define and use JPA/JPQL queries in Chapter 4 of the ObjectDB/JPA manual.
String getName()
Return the parameter name, or null if the parameter is not a named parameter or no name has been assigned.
Return the parameter name, or null if the parameter is not a named parameter or no name has been assigned.
Returns:
parameter name
Since:
JPA 2.0
Class<T> getParameterType()
Return the Java type of the 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 Java Persistence query language queries and native queries will not be portable.
Returns:
the Java type of the parameter
Throws:
IllegalStateException - if invoked on a parameter obtained from a Java persistence query language query or native query when the implementation does not support this use
Since:
JPA 2.0
Integer getPosition()
Return the parameter position, or null if the parameter is not a positional parameter.
Return the parameter position, or null if the parameter is not a positional parameter.
Returns:
position of parameter
Since:
JPA 2.0

This documentation page is derived (with some adjustments) from the open source JPA 2 RI (EclipseLink)
and is available under the terms of the Eclipse Public License, v. 1.0 and Eclipse Distribution License, v. 1.0.
Object Relational Mapping (ORM) JPA 2 providers include Hibernate, EclipseLink, TopLink, OpenJPA and DataNucleus.
Object DB is not an ORM JPA implementation but an Object Database for Java with built in JPA 2 support.