http://www.avaje.org/java8-parent/persistence-api: For open source java artifacts.
  • Rob Bygrave 
/*
 * 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 
EntityManager.getTransaction() method returns the EntityTransaction interface.

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

  
Start a resource transaction.

Throws:
  • IllegalStateException – if isActive() is true
/**
   * Start a resource transaction.
   *
   * @throws IllegalStateException if <code>isActive()</code> is true
   */
  public void begin();

  
Commit the current resource transaction, writing any
unflushed changes to the database.

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

  
Roll back the current resource transaction.

Throws:
  • IllegalStateException – if isActive() is false
  • PersistenceException –  if an unexpected error
                              condition is encountered
/**
   * Roll back the current resource transaction.
   *
   * @throws IllegalStateException if <code>isActive()</code> 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
/**
   * 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 <code>isActive()</code> is false
   */
  public void setRollbackOnly();

  
Determine whether the current resource transaction has been
marked for rollback.

Throws:
Returns:boolean indicating whether the transaction has been
marked for rollback
/**
   * 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 <code>isActive()</code> is false
   */
  public boolean getRollbackOnly();

  
Indicate whether a resource transaction is in progress.

Throws:
Returns:boolean indicating whether transaction is
in progress
/**
   * 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();
}