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