KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > sun > jts > CosTransactions > CompletionHandler


1 /*
2  * The contents of this file are subject to the terms
3  * of the Common Development and Distribution License
4  * (the License). You may not use this file except in
5  * compliance with the License.
6  *
7  * You can obtain a copy of the license at
8  * https://glassfish.dev.java.net/public/CDDLv1.0.html or
9  * glassfish/bootstrap/legal/CDDLv1.0.txt.
10  * See the License for the specific language governing
11  * permissions and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL
14  * Header Notice in each file and include the License file
15  * at glassfish/bootstrap/legal/CDDLv1.0.txt.
16  * If applicable, add the following below the CDDL Header,
17  * with the fields enclosed by brackets [] replaced by
18  * you own identifying information:
19  * "Portions Copyrighted [year] [name of copyright owner]"
20  *
21  * Copyright 2006 Sun Microsystems, Inc. All rights reserved.
22  */
23
24 /*
25  * Copyright 2004-2005 Sun Microsystems, Inc. All rights reserved.
26  * Use is subject to license terms.
27  */
28 //----------------------------------------------------------------------------
29 //
30 // Module: CompletionHandler.java
31 //
32 // Description: Common interface for transaction completion objects.
33 //
34 // Product: com.sun.jts.CosTransactions
35 //
36 // Author: Simon Holdsworth
37 //
38 // Date: March, 1997
39 //
40 // Copyright (c): 1995-1997 IBM Corp.
41 //
42 // The source code for this program is not published or otherwise divested
43 // of its trade secrets, irrespective of what has been deposited with the
44 // U.S. Copyright Office.
45 //
46 // This software contains confidential and proprietary information of
47 // IBM Corp.
48 //----------------------------------------------------------------------------
49
50 package com.sun.jts.CosTransactions;
51
52 //------------------------------------------------------------------------------
53 // CompletionHandler interface
54 //------------------------------------------------------------------------------
55 /**The CompletionHandler interface provides operations that allow an object
56  * to be informed when a Coordinator locally completes a transaction.
57  * <p>
58  * This is to allow the CoordinatorResource and CoordinatorTerm objects
59  * for a transaction to be informed when the Coordinator is completed via
60  * some path other than normal.
61  *
62  * @version 0.1
63  *
64  * @author Simon Holdsworth, IBM Corporation
65  *
66  * @see
67  */
68 // CHANGE HISTORY
69 //
70 // Version By Change Description
71 // 0.1 SAJH Initial implementation.
72 //------------------------------------------------------------------------------
73
74 interface CompletionHandler {
75
76     /**Informs the ComplemtionHandler object that the transaction it represents
77      * has completed.
78      * <p>
79      * Flags indicate whether the transaction aborted, and whether there was
80      * heuristic damage.
81      * <p>
82      * This operation is invoked by a Coordinator when it is rolled back,
83      * potentially by a caller other than the CompletionHandler itself.
84      *
85      * @param aborted Indicates whether the transaction locally aborted.
86      * @param heuristicDamage Indicates local heuristic damage.
87      *
88      * @return
89      *
90      * @see
91      */
92     abstract void setCompleted( boolean aborted,
93                                 boolean heuristicDamage );
94 }
95
Popular Tags