xref: /AOO42X/main/udkapi/com/sun/star/beans/TolerantPropertySetResultType.idl (revision d7a630b93db4316516c543e21eb4f4faf6d62bb4)
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#ifndef __com_sun_star_beans_TolerantPropertySetResultType_idl__
23#define __com_sun_star_beans_TolerantPropertySetResultType_idl__
24
25
26//=============================================================================
27
28module com {  module sun {  module star {  module beans {
29
30//=============================================================================
31
32/** specifies the possible failure types when using the
33    <type scope="com::sun::star::beans">XTolerantMultiPropertySet</type>
34    interface.
35
36    <p>It usually matches one of the exception types that may occur when
37    using the
38    <type scope="com::sun::star::beans">XPropertySet</type> or
39    <type scope="com::sun::star::beans">XMultiPropertySet</type> interfaces.</p>
40*/
41constants TolerantPropertySetResultType
42{
43    /** the property has been successfully set or retrieved.
44    */
45    const short SUCCESS             = 0;
46
47    /** the property is not available.
48
49        <p>For example if a
50        <type scope="com::sun::star::beans" >UnknownPropertyException</type>
51        was caught.</p>
52    */
53    const short UNKNOWN_PROPERTY    = 1;
54
55    /** the value used with the property is not valid.
56
57        <p>For example if a
58        <type scope="com::sun::star::lang" >IllegalArgumentException</type>
59        was caught.</p>
60    */
61    const short ILLEGAL_ARGUMENT    = 2;
62
63    /** the property could not be changed at that time.
64
65        <p>For example if a
66        <type scope="com::sun::star::beans" >PropertyVetoException</type>
67        was caught.</p>
68    */
69    const short PROPERTY_VETO       = 3;
70
71    /** a <type scope="com::sun::star::lang">WrappedTargetException</type>
72        did occur.
73    */
74    const short WRAPPED_TARGET      = 4;
75
76    /** the operation failed and the reason is not known.
77    */
78    const short UNKNOWN_FAILURE     = 5;
79};
80
81//=============================================================================
82
83}; }; }; };
84
85#endif
86