1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_util_XChangesBatch_idl__
24#define __com_sun_star_util_XChangesBatch_idl__
25
26#ifndef __com_sun_star_uno_XInterface_idl__
27#include <com/sun/star/uno/XInterface.idl>
28#endif
29
30#ifndef __com_sun_star_lang_WrappedTargetException_idl__
31#include <com/sun/star/lang/WrappedTargetException.idl>
32#endif
33
34#ifndef __com_sun_star_util_ChangesSet_idl__
35#include <com/sun/star/util/ChangesSet.idl>
36#endif
37
38
39//=============================================================================
40
41module com {  module sun {  module star {  module util {
42
43//=============================================================================
44/** this interface enables applying a set of changes in one batch transaction.
45
46	<p>An object implementing this interface allows other interfaces to change
47	its state locally. It will keep a list of pending changes until such changes
48	are committed or canceled.	</p>
49
50	<p>Only when they are explicitly committed will these changes take effect
51	persistently or globally.  </p>
52
53	@see XChangesNotifier
54	@see XChangesSet
55	@see XCancellable
56 */
57published interface XChangesBatch: com::sun::star::uno::XInterface
58{
59	//-------------------------------------------------------------------------
60	/** commits any pending changes.
61
62		<p>The exact action depends on the concrete service.  </p>
63	 */
64	void commitChanges()
65			raises( com::sun::star::lang::WrappedTargetException );
66
67	//-------------------------------------------------------------------------
68	/** checks whether this object has any pending changes that can be committed.
69	 */
70	boolean hasPendingChanges();
71
72	//-------------------------------------------------------------------------
73	/** queries for any pending changes that can be committed.
74	 */
75	ChangesSet getPendingChanges();
76};
77
78//=============================================================================
79
80}; }; }; };
81
82#endif
83