Top Description Methods
javax.persistence

public @Interface NamedQuery

extends Annotation
Annotations
@Repeatable:NamedQueries
@Target:TYPE
@Retention:RUNTIME
Imports
java.lang.annotation.Repeatable, .Target, .Retention

Specifies a static, named query in the Java Persistence query language. Query names are scoped to the persistence unit. The NamedQuery annotation can be applied to an entity or mapped superclass.

The following is an example of the definition of a named query in the Java Persistence query language:

   @NamedQuery(
           name="findAllCustomersWithName",
           query="SELECT c FROM Customer c WHERE c.name LIKE :custName"
   )

The following is an example of the use of a named query:

   @PersistenceContext
   public EntityManager em;
   ...
   customers = em.createNamedQuery("findAllCustomersWithName")
           .setParameter("custName", "Smith")
           .getResultList();
Since
Java Persistence 1.0

Method Summary

Modifier and TypeMethod and Description
public QueryHint[]
hints()

(Optional) Query properties and hints.

public LockModeType
lockMode()

(Optional) The lock mode type to use in query execution.

public String
name()

(Required) The name used to refer to the query with the EntityManager methods that create query objects.

public String
query()

(Required) The query string in the Java Persistence query language.

Inherited from java.lang.annotation.Annotation:
annotationTypeequalshashCodetoString

Method Detail

hintsback to summary
public QueryHint[] hints()

(Optional) Query properties and hints. May include vendor-specific query hints.

lockModeback to summary
public LockModeType lockMode()

(Optional) The lock mode type to use in query execution. If a lockMode other than LockModeType.NONE is specified, the query must be executed in a transaction and the persistence context joined to the transaction.

Since
Java Persistence 2.0
nameback to summary
public String name()

(Required) The name used to refer to the query with the EntityManager methods that create query objects.

queryback to summary
public String query()

(Required) The query string in the Java Persistence query language.