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

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