/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: MergeRecoveryRequest.idl,v $
 *
 *  $Revision: 1.4 $
 *
 *  last change: $Author: rt $ $Date: 2005-09-07 22:35:22 $
 *
 *  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_configuration_backend_MergeRecoveryRequest_idl__
#define __com_sun_star_configuration_backend_MergeRecoveryRequest_idl__

#ifndef __com_sun_star_uno_Exception_idl__
#include <com/sun/star/uno/Exception.idl>
#endif

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

module com { module sun { module star { module configuration { module backend {

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

/** is passed to an <type>InteractionHandler<type> when merging fails due to
    invalid layer data or access problems.

    @since OOo 2.0.0
 */
exception MergeRecoveryRequest: ::com::sun::star::uno::Exception
{
    /**
        data that provides more detailed information about the
        reason and location of the error.

        <p> Typically this member should contain an exception characterizing
            the error in detail.
        </p>
        <p> For example the following exceptions may be used:
        <dl>
            <dt><type>MalformedException</type></dt>
            <dd>for layers containing invalid data.</dd>

            <dt><type>BackendAccessException</type></dt>
            <dd>for layers that can't be accessed.</dd>
        </dl>
        </p>
        <p> If no more detail information is available, this may be left <void/>.
        </p>
    */
    any ErrorDetails;

    /**
        Identifier of the layer object containing the invalid data.
    */
    string ErrorLayerId;

    /**
        specifies whether the requestor wants to remove or skip the invalid layer.

        <p> If <TRUE/> the requestor wants to remove the underlying data of
            the layer.<BR/>
            If <FALSE/> the request is to skip the underlying data this time,
            but without removing it.
        </p>
    */
    boolean IsRemovalRequest;

};

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

}; }; }; }; };

#endif
