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
  20
  21
  22 module com {  module sun {  module star {  module util {
  23
  24 /** this interface enables applying a set of changes in one batch transaction.
  25
  26     <p>An object implementing this interface allows other interfaces to change
  27     its state locally. It will keep a list of pending changes until such changes
  28     are committed or canceled.  </p>
  29
  30     <p>Only when they are explicitly committed will these changes take effect
  31     persistently or globally.  </p>
  32
  33     @see XChangesNotifier
  34     @see XChangesSet
  35     @see XCancellable
  36  */
  37 published interface XChangesBatch: com::sun::star::uno::XInterface
  38 {
  39     /** commits any pending changes.
  40
  41         <p>The exact action depends on the concrete service.  </p>
  42      */
  43     void commitChanges()
  44             raises( com::sun::star::lang::WrappedTargetException );
  45
  46     /** checks whether this object has any pending changes that can be committed.
  47      */
  48     boolean hasPendingChanges();
  49
  50     /** queries for any pending changes that can be committed.
  51      */
  52     ChangesSet getPendingChanges();
  53 };
  54
  55
  56 }; }; }; };
  57
  58 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */