xref: /AOO41X/main/offapi/com/sun/star/configuration/backend/MalformedDataException.idl (revision cdf0e10c4e3984b49a9502b011690b615761d4a3)
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_MalformedDataException_idl__
28#define __com_sun_star_configuration_backend_MalformedDataException_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 raised when the data of a component schema, layer or update
41	is not well-formed, violates the schema or is otherwise invalid.
42
43    @since OOo 1.1.2
44 */
45published exception MalformedDataException: ::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 scope="com::sun::star::container">ElementExistException</type></dt>
57            <dd>for duplicate nodes.</dd>
58
59            <dt><type scope="com::sun::star::container">NoSuchElementException</type></dt>
60            <dd>for nodes that are not in the schema.</dd>
61
62            <dt><type scope="com::sun::star::beans">IllegalTypeException</type></dt>
63            <dd>for properties having the wrong or an invalid type.</dd>
64
65            <dt><type scope="com::sun::star::beans">PropertyExistException</type></dt>
66            <dd>for duplicate properties.</dd>
67
68            <dt><type scope="com::sun::star::beans">UnknownPropertyException</type></dt>
69            <dd>for properties that are not in the schema.</dd>
70
71            <dt><type scope="com::sun::star::lang">IllegalArgumentException</type></dt>
72            <dd>for data values (names,attibutes,etc.) that are invalid.</dd>
73
74            <dt><type scope="com::sun::star::lang">IllegalAccessException</type></dt>
75            <dd>for changes that violate access restrictions.</dd>
76
77            <dt><type scope="com::sun::star::lang">NoSupportException</type></dt>
78            <dd>for features that are not supported by the current implementation.</dd>
79        </dl>
80        </p>
81        <p> If no more detail information is available, this may be left <void/>.
82        </p>
83    */
84	any ErrorDetails;
85};
86
87//=============================================================================
88
89}; }; }; }; };
90
91#endif
92