01 /*
02 * Copyright 2000-2005 Sun Microsystems, Inc. All Rights Reserved.
03 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
04 *
05 * This code is free software; you can redistribute it and/or modify it
06 * under the terms of the GNU General Public License version 2 only, as
07 * published by the Free Software Foundation. Sun designates this
08 * particular file as subject to the "Classpath" exception as provided
09 * by Sun in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
22 * CA 95054 USA or visit www.sun.com if you need additional information or
23 * have any questions.
24 */
25
26 package java.sql;
27
28 /**
29 * The representation of a savepoint, which is a point within
30 * the current transaction that can be referenced from the
31 * <code>Connection.rollback</code> method. When a transaction
32 * is rolled back to a savepoint all changes made after that
33 * savepoint are undone.
34 * <p>
35 * Savepoints can be either named or unnamed. Unnamed savepoints
36 * are identified by an ID generated by the underlying data source.
37 *
38 * @since 1.4
39 */
40
41 public interface Savepoint {
42
43 /**
44 * Retrieves the generated ID for the savepoint that this
45 * <code>Savepoint</code> object represents.
46 * @return the numeric ID of this savepoint
47 * @exception SQLException if this is a named savepoint
48 * @since 1.4
49 */
50 int getSavepointId() throws SQLException;
51
52 /**
53 * Retrieves the name of the savepoint that this <code>Savepoint</code>
54 * object represents.
55 * @return the name of this savepoint
56 * @exception SQLException if this is an un-named savepoint
57 * @since 1.4
58 */
59 String getSavepointName() throws SQLException;
60 }
|