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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_util_XChangesBatch_idl__
  20 #define __com_sun_star_util_XChangesBatch_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23
  24 #include <com/sun/star/lang/WrappedTargetException.idl>
  25
  26 #include <com/sun/star/util/ChangesSet.idl>
  27
  28
  29
  30 module com {  module sun {  module star {  module util {
  31
  32 /** this interface enables applying a set of changes in one batch transaction.
  33
  34     <p>An object implementing this interface allows other interfaces to change
  35     its state locally. It will keep a list of pending changes until such changes
  36     are committed or canceled.  </p>
  37
  38     <p>Only when they are explicitly committed will these changes take effect
  39     persistently or globally.  </p>
  40
  41     @see XChangesNotifier
  42     @see XChangesSet
  43     @see XCancellable
  44  */
  45 published interface XChangesBatch: com::sun::star::uno::XInterface
  46 {
  47     /** commits any pending changes.
  48
  49         <p>The exact action depends on the concrete service.  </p>
  50      */
  51     void commitChanges()
  52             raises( com::sun::star::lang::WrappedTargetException );
  53
  54     /** checks whether this object has any pending changes that can be committed.
  55      */
  56     boolean hasPendingChanges();
  57
  58     /** queries for any pending changes that can be committed.
  59      */
  60     ChangesSet getPendingChanges();
  61 };
  62
  63
  64 }; }; }; };
  65
  66 #endif
  67
  68 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */