summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/configuration/backend/MergeRecoveryRequest.idl
blob: 569c4a33861bca875c093d6e061e86ceb27bdd8b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */
#ifndef __com_sun_star_configuration_backend_MergeRecoveryRequest_idl__
#define __com_sun_star_configuration_backend_MergeRecoveryRequest_idl__

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


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


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

    @since OOo 2.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>MalformedException</dt>
            <dd>for layers containing invalid data.</dd>

            <dt>BackendAccessException</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 requester wants to remove or skip the invalid layer.

        <p> If `TRUE` the requester 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

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */