/*
 * Copyright (c) 2008, 2009, 2011 Oracle, Inc. All rights reserved.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License v1.0 and Eclipse Distribution License v. 1.0
 * which accompanies this distribution.  The Eclipse Public License is available
 * at http://www.eclipse.org/legal/epl-v10.html and the Eclipse Distribution License
 * is available at http://www.eclipse.org/org/documents/edl-v10.php.
 */
package javax.persistence;

import java.lang.annotation.Repeatable;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;

import static java.lang.annotation.ElementType.TYPE;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

Specifies a named native SQL query. Query names are scoped to the persistence unit. The
NamedNativeQuery annotation can be applied to an entity or mapped superclass.
Since:
Java Persistence 1.0/**
 * Specifies a named native SQL query. Query names are scoped to the persistence unit. The
 * <code>NamedNativeQuery</code> annotation can be applied to an entity or mapped superclass.
 *
 * @since Java Persistence 1.0
 */
@Target({TYPE})
@Retention(RUNTIME)
@Repeatable(NamedNativeQueries.class)
public @interface NamedNativeQuery {
  
The name used to refer to the query with the EntityManager methods that create query objects. 
Returns:
The name/**
   * The name used to refer to the query with the {@link EntityManager} methods that create query objects.
   *
   * @return The name
   */
  String name();

  
The SQL query string.
Returns:
The SQL string/**
   * The SQL query string.
   *
   * @return The SQL string
   */
  String query();

  
Query properties and hints. (May include vendor-specific query hints.)
Returns:
any hints/**
   * Query properties and hints. (May include vendor-specific query hints.)
   *
   * @return any hints
   */
  QueryHint[] hints() default {};

  
The class of the result.
Returns:
The result class/**
   * The class of the result.
   *
   * @return The result class
   */
  Class resultClass() default void.class;

  
The name of a SqlResultSetMapping, as defined in metadata. 
Returns:
ResultSet mapping/**
   * The name of a {@link SqlResultSetMapping}, as defined in metadata.
   *
   * @return ResultSet mapping
   */
  String resultSetMapping() default "";
}