javax.persistence.Parameter Maven / Gradle / Ivy
// $Id: $
// EJB3 Specification Copyright 2004-2009 Sun Microsystems, Inc.
package javax.persistence;
/**
* Type for query parameter objects.
* @param the type of the parameter
*
* @see Query
* @see TypedQuery
*
* @since Java Persistence 2.0
*/
public interface Parameter {
/**
* Return the parameter name, or null if the parameter is
* not a named parameter or no name has been assigned.
* @return parameter name
*/
String getName();
/**
* Return the parameter position, or null if the parameter
* is not a positional parameter.
* @return position of parameter
*/
Integer getPosition();
/**
* 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.
* @return 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
*/
Class getParameterType();
}