udkapi/com/sun/star/beans/XTolerantMultiPropertySet.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_beans_XTolerantMultiPropertySet_idl__
  20 #define __com_sun_star_beans_XTolerantMultiPropertySet_idl__
  21
  22
  23 #include <com/sun/star/uno/XInterface.idl>
  24 #include <com/sun/star/beans/GetDirectPropertyTolerantResult.idl>
  25 #include <com/sun/star/beans/GetPropertyTolerantResult.idl>
  26 #include <com/sun/star/beans/SetPropertyTolerantFailed.idl>
  27 #include <com/sun/star/lang/IllegalArgumentException.idl>
  28
  29
  30
  31 module com {  module sun {  module star {  module beans {
  32
  33
  34 /** provides access to multiple iformation of
  35     a set of properties with a single call.
  36
  37     <p>The speciality of this interface is that none of the functions
  38     will throw the usual exceptions associated with setting and retrieving
  39     of property values. Instead the data for the failures is collected and
  40     returned.</p>
  41
  42     <p>Note: There is no support for property change listeners in this
  43     interface.</p>
  44
  45     @see com::sun::star::beans::XPropertySet
  46     @see com::sun::star::beans::XMultiPropertySet
  47  */
  48 published interface XTolerantMultiPropertySet : com::sun::star::uno::XInterface
  49 {
  50
  51     /** sets the values to the properties with the specified names.
  52
  53         @param aPropertyNames
  54             specifies the names of the properties.
  55             The property names must be sorted ascending.
  56
  57             <p>If the names are not sorted the behaviour of the method
  58             is undefined!</p>
  59
  60         @param aValues
  61             specifies the values of the properties.
  62             The order of the values has to be the same as in the
  63             <var>aPropertyNames</var> parameter int order to match
  64             the property name with its value.
  65
  66         @returns
  67             An empty sequence if all properties are successful set.
  68
  69             Otherwise for every property value that could not successfully
  70             be set an entry of the
  71             com::sun::star::beans::SetPropertyTolerantFailed
  72             will be present in this sequence.
  73             The order of the properties is also alphabetically ascending.
  74
  75         @throws IllegalArgumentException
  76             if the number of property names and values do not match.
  77
  78      */
  79     sequence< com::sun::star::beans::SetPropertyTolerantFailed > setPropertyValuesTolerant(
  80                 [in] sequence< string > aPropertyNames,
  81                 [in] sequence< any >    aValues )
  82         raises( com::sun::star::lang::IllegalArgumentException );
  83
  84
  85     /** retrieve the values of the specified properties
  86
  87         <p>The count and order of the values in the returned sequence
  88             will be the same as the order of the names in the argument.</p>
  89
  90         @param aPropertyNames
  91             specifies the names of the properties.
  92             The property names must be sorted ascending.
  93
  94             <p>If the names are not sorted the behaviour of the method
  95             is undefined!</p>
  96
  97         @returns
  98             a sequence of type
  99             com::sun::star::beans::GetPropertyTolerantResult
 100             for each of the properties listed in <var>aPropertyNames</var>.
 101      */
 102     sequence< com::sun::star::beans::GetPropertyTolerantResult > getPropertyValuesTolerant(
 103                 [in] sequence< string > aPropertyNames );
 104
 105
 106
 107     /** retrieve only those values of the specified properties which
 108         are direct values.
 109
 110         <p>Since the count of returned elements may be different from
 111         the number of supplied property names the returned elements
 112         will also state the name of the property.</p>
 113
 114         @param aPropertyNames
 115             specifies the names of the properties.
 116             The property names must be sorted ascending.
 117
 118             <p>If the names are not sorted the behaviour of the method
 119             is undefined!</p>
 120
 121         @returns
 122             a sequence of type
 123             com::sun::star::beans::GetDirectPropertyTolerantResult
 124             but only for those properties supplied whoms state is
 125             com::sun::star::beans::PropertyState::DIRECT_VALUE.
 126      */
 127     sequence< com::sun::star::beans::GetDirectPropertyTolerantResult > getDirectPropertyValuesTolerant(
 128                 [in] sequence< string > aPropertyNames );
 129
 130 };
 131
 132
 133 }; }; }; };
 134
 135 #endif
 136
 137 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */