1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_configuration_backend_MergeRecoveryRequest_idl__
24#define __com_sun_star_configuration_backend_MergeRecoveryRequest_idl__
25
26#ifndef __com_sun_star_uno_Exception_idl__
27#include <com/sun/star/uno/Exception.idl>
28#endif
29
30//=============================================================================
31
32module com { module sun { module star { module configuration { module backend {
33
34//=============================================================================
35
36/** is passed to an <type>InteractionHandler<type> when merging fails due to
37	invalid layer data or access problems.
38
39    @since OOo 2.0
40 */
41exception MergeRecoveryRequest: ::com::sun::star::uno::Exception
42{
43    /**
44        data that provides more detailed information about the
45        reason and location of the error.
46
47        <p> Typically this member should contain an exception characterizing
48            the error in detail.
49        </p>
50        <p> For example the following exceptions may be used:
51        <dl>
52            <dt><type>MalformedException</type></dt>
53            <dd>for layers containing invalid data.</dd>
54
55            <dt><type>BackendAccessException</type></dt>
56            <dd>for layers that can't be accessed.</dd>
57        </dl>
58        </p>
59        <p> If no more detail information is available, this may be left <void/>.
60        </p>
61    */
62	any ErrorDetails;
63
64    /**
65        Identifier of the layer object containing the invalid data.
66    */
67    string ErrorLayerId;
68
69    /**
70        specifies whether the requestor wants to remove or skip the invalid layer.
71
72        <p> If <TRUE/> the requestor wants to remove the underlying data of
73            the layer.<BR/>
74            If <FALSE/> the request is to skip the underlying data this time,
75            but without removing it.
76        </p>
77    */
78    boolean IsRemovalRequest;
79
80};
81
82//=============================================================================
83
84}; }; }; }; };
85
86#endif
87