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_configuration_backend_MergeRecoveryRequest_idl__
28#define __com_sun_star_configuration_backend_MergeRecoveryRequest_idl__
29
30#ifndef __com_sun_star_uno_Exception_idl__
31#include <com/sun/star/uno/Exception.idl>
32#endif
33
34//=============================================================================
35
36module com { module sun { module star { module configuration { module backend {
37
38//=============================================================================
39
40/** is passed to an <type>InteractionHandler<type> when merging fails due to
41	invalid layer data or access problems.
42
43    @since OOo 2.0
44 */
45exception MergeRecoveryRequest: ::com::sun::star::uno::Exception
46{
47    /**
48        data that provides more detailed information about the
49        reason and location of the error.
50
51        <p> Typically this member should contain an exception characterizing
52            the error in detail.
53        </p>
54        <p> For example the following exceptions may be used:
55        <dl>
56            <dt><type>MalformedException</type></dt>
57            <dd>for layers containing invalid data.</dd>
58
59            <dt><type>BackendAccessException</type></dt>
60            <dd>for layers that can't be accessed.</dd>
61        </dl>
62        </p>
63        <p> If no more detail information is available, this may be left <void/>.
64        </p>
65    */
66	any ErrorDetails;
67
68    /**
69        Identifier of the layer object containing the invalid data.
70    */
71    string ErrorLayerId;
72
73    /**
74        specifies whether the requestor wants to remove or skip the invalid layer.
75
76        <p> If <TRUE/> the requestor wants to remove the underlying data of
77            the layer.<BR/>
78            If <FALSE/> the request is to skip the underlying data this time,
79            but without removing it.
80        </p>
81    */
82    boolean IsRemovalRequest;
83
84};
85
86//=============================================================================
87
88}; }; }; }; };
89
90#endif
91