summaryrefslogtreecommitdiffstats
path: root/sca-java-1.x/tags/java-M1-final/java/das/rdb/src/main/java/org/apache/tuscany/das/rdb/ApplyChangesCommand.java
blob: 75f81ca1e3dcf3377847e4f559ca766deac81fc6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
/**
 *
 *  Copyright 2005 The Apache Software Foundation or its licensors, as applicable.
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 */
package org.apache.tuscany.das.rdb;

import java.sql.Connection;

import commonj.sdo.DataObject;
import commonj.sdo.Type;

/**
 * An ApplyChangesCommand is used to flush the changes associated with a
 * modified graph of DataObjects to a database.
 * 
 * 
 */
public interface ApplyChangesCommand {

	/**
	 * Adds a user-provided update command. In the absence of a user-provided
	 * command, the DAS will generate one. However this alternative may make
	 * sense if the user requires a SQL statement different from what the DAS
	 * generates.
	 * 
	 * @param type
	 *            The DataObject type this command applys to
	 * @param cmd
	 *            The Command used to UPDATE data objects of the specified type
	 */
	public void addUpdateCommand(Type type, Command cmd);

	/**
	 * Adds a user-provided create command. In the absence of a user-provided
	 * command, the DAS will generate one. However this alternative may make
	 * sense if the user requires a SQL statement different from what the DAS
	 * generates.
	 * 
	 * @param type
	 *            The DataObject type this command applys to
	 * @param cmd
	 *            The Command used to INSERT data objects of the specified type
	 */
	public void addCreateCommand(Type type, Command cmd);

	/**
	 * Adds a user-provided delete command. In the absence of a user-provided
	 * command, the DAS will generate one. However this alternative may make
	 * sense if the user requires a SQL statement different from what the DAS
	 * generates.
	 * 
	 * @param type
	 *            The DataObject type this command applys to
	 * @param cmd
	 *            The Command used to DELETE data objects of the specified type
	 */
	public void addDeleteCommand(Type type, Command cmd);

	/**
	 * The change history is scanned and modifications to the graph of data
	 * objects are flushed to the database.
	 * 
	 * @param root
	 *            the topmost containing data object
	 */
	public void execute(DataObject root);

	/**
	 * Provides the java.sql.Connection to be used for this executing this
	 * command.
	 * 
	 * @param connection
	 *            the java.sql.Connection
	 */
	public void setConnection(Connection connection);

	/**
	 * Provides the java.sql.Connection to be used for this executing this
	 * command.
	 * 
	 * @param connection
	 *            the java.sql.Connection
	 * @param manageTransactions
	 *            <code>true</code> if the DAS should perform tx
	 *            commit/rollback
	 */
	public void setConnection(Connection connection, boolean manageTransactions);

}