javax.persistence.EntityTransaction Maven / Gradle / Ivy

Go to download
/*
 * 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;

/**
 * Interface used to control transactions on resource-local entity
 * managers.  The {@link EntityManager#getTransaction
 * EntityManager.getTransaction()} method returns the
 * EntityTransaction interface.
 *
 * @since Java Persistence 1.0
 */
public interface EntityTransaction {

  /**
   * Start a resource transaction.
   *
   * @throws IllegalStateException if isActive() is true
   */
  public void begin();

  /**
   * Commit the current resource transaction, writing any
   * unflushed changes to the database.
   *
   * @throws IllegalStateException if isActive() is false
   * @throws RollbackException     if the commit fails
   */
  public void commit();

  /**
   * Roll back the current resource transaction.
   *
   * @throws IllegalStateException if isActive() is false
   * @throws PersistenceException  if an unexpected error
   *                               condition is encountered
   */
  public void rollback();

  /**
   * Mark the current resource transaction so that the only
   * possible outcome of the transaction is for the transaction
   * to be rolled back.
   *
   * @throws IllegalStateException if isActive() is false
   */
  public void setRollbackOnly();

  /**
   * Determine whether the current resource transaction has been
   * marked for rollback.
   *
   * @return boolean indicating whether the transaction has been
   * marked for rollback
   * @throws IllegalStateException if isActive() is false
   */
  public boolean getRollbackOnly();

  /**
   * Indicate whether a resource transaction is in progress.
   *
   * @return boolean indicating whether transaction is
   * in progress
   * @throws PersistenceException if an unexpected error
   *                              condition is encountered
   */
  public boolean isActive();
}