summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/configuration/backend/MalformedDataException.idl
blob: d2936d9b097da416fa9b3dc98444a441afd5b109 (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
80
/* -*- 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_MalformedDataException_idl__
#define __com_sun_star_configuration_backend_MalformedDataException_idl__

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


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


/** is raised when the data of a component schema, layer or update
    is not well-formed, violates the schema or is otherwise invalid.

    @since OOo 1.1.2
 */
published exception MalformedDataException: ::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 scope="com::sun::star::container">ElementExistException</type></dt>
            <dd>for duplicate nodes.</dd>

            <dt><type scope="com::sun::star::container">NoSuchElementException</type></dt>
            <dd>for nodes that are not in the schema.</dd>

            <dt><type scope="com::sun::star::beans">IllegalTypeException</type></dt>
            <dd>for properties having the wrong or an invalid type.</dd>

            <dt><type scope="com::sun::star::beans">PropertyExistException</type></dt>
            <dd>for duplicate properties.</dd>

            <dt><type scope="com::sun::star::beans">UnknownPropertyException</type></dt>
            <dd>for properties that are not in the schema.</dd>

            <dt><type scope="com::sun::star::lang">IllegalArgumentException</type></dt>
            <dd>for data values (names,attributes,etc.) that are invalid.</dd>

            <dt><type scope="com::sun::star::lang">IllegalAccessException</type></dt>
            <dd>for changes that violate access restrictions.</dd>

            <dt><type scope="com::sun::star::lang">NoSupportException</type></dt>
            <dd>for features that are not supported by the current implementation.</dd>
        </dl>
        </p>
        <p> If no more detail information is available, this may be left <void/>.
        </p>
    */
    any ErrorDetails;
};


}; }; }; }; };

#endif

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