01: /*
02: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
03: *
04: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
05: *
06: * The contents of this file are subject to the terms of either the GNU
07: * General Public License Version 2 only ("GPL") or the Common Development
08: * and Distribution License("CDDL") (collectively, the "License"). You
09: * may not use this file except in compliance with the License. You can obtain
10: * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
11: * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
12: * language governing permissions and limitations under the License.
13: *
14: * When distributing the software, include this License Header Notice in each
15: * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
16: * Sun designates this particular file as subject to the "Classpath" exception
17: * as provided by Sun in the GPL Version 2 section of the License file that
18: * accompanied this code. If applicable, add the following below the License
19: * Header, with the fields enclosed by brackets [] replaced by your own
20: * identifying information: "Portions Copyrighted [year]
21: * [name of copyright owner]"
22: *
23: * Contributor(s):
24: *
25: * If you wish your version of this file to be governed by only the CDDL or
26: * only the GPL Version 2, indicate your decision by adding "[Contributor]
27: * elects to include this software in this distribution under the [CDDL or GPL
28: * Version 2] license." If you don't indicate a single choice of license, a
29: * recipient has the option to distribute your version of this file under
30: * either the CDDL, the GPL Version 2 or to extend the choice of license to
31: * its licensees as provided above. However, if you add GPL Version 2 code
32: * and therefore, elected the GPL Version 2 license, then the option applies
33: * only if the new code is made subject to such option by the copyright
34: * holder.
35: */
36: package javax.persistence;
37:
38: /**
39: * The <code>EntityTransaction</code> interface is used to control
40: * resource transactions on resource-local entity managers. The
41: * {@link EntityManager#getTransaction EntityManager.getTransaction()}
42: * method returns the <code>EntityTransaction</code> interface.
43: *
44: * @since Java Persistence 1.0
45: */
46: public interface EntityTransaction {
47: /**
48: * Start the resource transaction.
49: * @throws IllegalStateException if {@link #isActive()} is true.
50: */
51: public void begin();
52:
53: /**
54: * Commit the current transaction, writing any unflushed
55: * changes to the database.
56: * @throws IllegalStateException if {@link #isActive()} is false.
57: * @throws RollbackException if the commit fails.
58: */
59: public void commit();
60:
61: /**
62: * Roll back the current transaction
63: * @throws IllegalStateException if {@link #isActive()} is false.
64: * @throws PersistenceException if an unexpected error
65: * condition is encountered.
66: */
67: public void rollback();
68:
69: /**
70: * Mark the current transaction so that the only possible
71: * outcome of the transaction is for the transaction to be
72: * rolled back.
73: * @throws IllegalStateException if {@link #isActive()} is false.
74: */
75: public void setRollbackOnly();
76:
77: /**
78: * Determine whether the current transaction has been marked
79: * for rollback.
80: * @throws IllegalStateException if {@link #isActive()} is false.
81: */
82: public boolean getRollbackOnly();
83:
84: /**
85: * Indicate whether a transaction is in progress.
86: * @throws PersistenceException if an unexpected error
87: * condition is encountered.
88: */
89: public boolean isActive();
90: }
|