(no commit message)
[utils] / test / enterprise / src / main / java / org / wamblee / test / transactions / TransactionResource.java
1 /*
2  * Copyright 2005-2010 the original author or authors.
3  * 
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  * 
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  * 
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 package org.wamblee.test.transactions;
17
18 /**
19  * Interfaces to be implemented by resources that want to participate in
20  * transactions managed through {@link SimpleTransactionManager}.
21  * 
22  * @author Erik Brakkee
23  * 
24  * @param <T>
25  */
26 public interface TransactionResource<T> {
27
28     /**
29      * Begins a transaction.
30      * 
31      * @return Object that manages the transaction for the resource.
32      */
33     T begin();
34
35     /**
36      * Rolls back a transaction.
37      * 
38      * @param aT
39      *            Object that manages the transaction for the resource.
40      */
41     TransactionResult rollback(T aT);
42
43     /**
44      * Commits the transaction.
45      * 
46      * @param aT
47      *            Object that manages the transaction for the resource.
48      */
49     TransactionResult commit(T aT);
50
51 }