/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: XChangesBatch.idl,v $
 *
 *  $Revision: 1.8 $
 *
 *  last change: $Author: rt $ $Date: 2005-09-08 08:59:34 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 by Sun Microsystems, Inc.
 *    901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License version 2.1, as published by the Free Software Foundation.
 *
 *    This library is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *    Lesser General Public License for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with this library; if not, write to the Free Software
 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *    MA  02111-1307  USA
 *
 ************************************************************************/
#ifndef __com_sun_star_util_XChangesBatch_idl__
#define __com_sun_star_util_XChangesBatch_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_lang_WrappedTargetException_idl__
#include <com/sun/star/lang/WrappedTargetException.idl>
#endif

#ifndef __com_sun_star_util_ChangesSet_idl__
#include <com/sun/star/util/ChangesSet.idl>
#endif


//=============================================================================

module com {  module sun {  module star {  module util {

//=============================================================================
/** this interface enables applying a set of changes in one batch transaction.

    <p>An object implementing this interface allows other interfaces to change
    its state locally. It will keep a list of pending changes until such changes
    are committed or cancelled. </p>

    <p>Only when they are explicitly committed will these changes take effect
    persistently or globally.  </p>

    @see XChangesNotifier
    @see XChangesSet
    @see XCancellable
 */
published interface XChangesBatch: com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------
    /** commits any pending changes.

        <p>The exact action depends on the concrete service.  </p>
     */
    void commitChanges()
            raises( com::sun::star::lang::WrappedTargetException );

    //-------------------------------------------------------------------------
    /** checks whether this object has any pending changes that can be committed.
     */
    boolean hasPendingChanges();

    //-------------------------------------------------------------------------
    /** queries for any pending changes that can be committed.
     */
    ChangesSet getPendingChanges();
};

//=============================================================================

}; }; }; };

#endif
