offapi/com/sun/star/util/XChangesBatch.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XChangesBatch.idl,v $
  10  * $Revision: 1.9 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_util_XChangesBatch_idl__
  31 #define __com_sun_star_util_XChangesBatch_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_lang_WrappedTargetException_idl__
  38 #include <com/sun/star/lang/WrappedTargetException.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_util_ChangesSet_idl__
  42 #include <com/sun/star/util/ChangesSet.idl>
  43 #endif
  44
  45
  46 //=============================================================================
  47
  48 module com {  module sun {  module star {  module util {
  49
  50 //=============================================================================
  51 /** this interface enables applying a set of changes in one batch transaction.
  52
  53     <p>An object implementing this interface allows other interfaces to change
  54     its state locally. It will keep a list of pending changes until such changes
  55     are committed or cancelled. </p>
  56
  57     <p>Only when they are explicitly committed will these changes take effect
  58     persistently or globally.  </p>
  59
  60     @see XChangesNotifier
  61     @see XChangesSet
  62     @see XCancellable
  63  */
  64 published interface XChangesBatch: com::sun::star::uno::XInterface
  65 {
  66     //-------------------------------------------------------------------------
  67     /** commits any pending changes.
  68
  69         <p>The exact action depends on the concrete service.  </p>
  70      */
  71     void commitChanges()
  72             raises( com::sun::star::lang::WrappedTargetException );
  73
  74     //-------------------------------------------------------------------------
  75     /** checks whether this object has any pending changes that can be committed.
  76      */
  77     boolean hasPendingChanges();
  78
  79     //-------------------------------------------------------------------------
  80     /** queries for any pending changes that can be committed.
  81      */
  82     ChangesSet getPendingChanges();
  83 };
  84
  85 //=============================================================================
  86
  87 }; }; }; };
  88
  89 #endif