/*
 * 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;

Thrown by the persistence provider when a query times out
and only the statement is rolled back.
The current transaction, if one is active, will be not
be marked for rollback.
Since:
Java Persistence 2.0/**
 * Thrown by the persistence provider when a query times out
 * and only the statement is rolled back.
 * The current transaction, if one is active, will be not
 * be marked for rollback.
 *
 * @since Java Persistence 2.0
 */
public class QueryTimeoutException extends PersistenceException {
  
The query object that caused the exception
/**
   * The query object that caused the exception
   */
  Query query;

  
Constructs a new QueryTimeoutException exception
with null as its detail message.
/**
   * Constructs a new <code>QueryTimeoutException</code> exception
   * with <code>null</code> as its detail message.
   */
  public QueryTimeoutException() {
    super();
  }

  
Constructs a new QueryTimeoutException exception
with the specified detail message.
Params:
message – the detail message./**
   * Constructs a new <code>QueryTimeoutException</code> exception
   * with the specified detail message.
   *
   * @param message the detail message.
   */
  public QueryTimeoutException(String message) {
    super(message);
  }

  
Constructs a new QueryTimeoutException exception
with the specified detail message and cause.
Params:
message – the detail message.
cause –   the cause./**
   * Constructs a new <code>QueryTimeoutException</code> exception
   * with the specified detail message and cause.
   *
   * @param message the detail message.
   * @param cause   the cause.
   */
  public QueryTimeoutException(String message, Throwable cause) {
    super(message, cause);
  }

  
Constructs a new QueryTimeoutException exception
with the specified cause.
Params:
cause – the cause./**
   * Constructs a new <code>QueryTimeoutException</code> exception
   * with the specified cause.
   *
   * @param cause the cause.
   */
  public QueryTimeoutException(Throwable cause) {
    super(cause);
  }


  
Constructs a new QueryTimeoutException exception
with the specified query.
Params:
query – the query./**
   * Constructs a new <code>QueryTimeoutException</code> exception
   * with the specified query.
   *
   * @param query the query.
   */
  public QueryTimeoutException(Query query) {
    this.query = query;
  }

  
Constructs a new QueryTimeoutException exception
with the specified detail message, cause, and query.
Params:
message – the detail message.
cause –   the cause.
query –   the query./**
   * Constructs a new <code>QueryTimeoutException</code> exception
   * with the specified detail message, cause, and query.
   *
   * @param message the detail message.
   * @param cause   the cause.
   * @param query   the query.
   */
  public QueryTimeoutException(String message, Throwable cause, Query query) {
    super(message, cause);
    this.query = query;
  }

  
Returns the query that caused this exception.
Returns:
the query./**
   * Returns the query that caused this exception.
   *
   * @return the query.
   */
  public Query getQuery() {
    return this.query;
  }
}