udkapi/com/sun/star/beans/XPropertyAccess.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_XPropertyAccess_idl__
  20 #define __com_sun_star_beans_XPropertyAccess_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23
  24 #include <com/sun/star/beans/PropertyValue.idl>
  25
  26 #include <com/sun/star/beans/UnknownPropertyException.idl>
  27
  28 #include <com/sun/star/beans/PropertyVetoException.idl>
  29
  30 #include <com/sun/star/lang/IllegalArgumentException.idl>
  31
  32 #include <com/sun/star/lang/WrappedTargetException.idl>
  33
  34
  35
  36 module com {  module sun {  module star {  module beans {
  37
  38
  39 /** makes it possible to access all property values and to set them at once.
  40
  41     <p>In most cases this interface will be in addition to
  42     XPropertySet. It is especially useful for remote
  43     communication because it lessens the number of calls for getting
  44     property values; that is especially important because these calls
  45     are necessarily synchronous.  </p>
  46
  47     <p>Another advantage of this method is that conflicts are avoided
  48     if property value restrictions depend on the value of other properties.</p>
  49  */
  50 published interface XPropertyAccess: com::sun::star::uno::XInterface
  51 {
  52
  53     /** @returns
  54             a sequence of all property values within the object in a single call.
  55      */
  56     sequence<com::sun::star::beans::PropertyValue> getPropertyValues();
  57
  58
  59     /** sets the values of given properties.
  60
  61         <p>All properties which are not contained in the sequence
  62         <var>aProps</var> will be left unchanged.</p>
  63      */
  64     void setPropertyValues( [in] sequence<com::sun::star::beans::PropertyValue> aProps )
  65             raises( com::sun::star::beans::UnknownPropertyException,
  66                     com::sun::star::beans::PropertyVetoException,
  67                     com::sun::star::lang::IllegalArgumentException,
  68                     com::sun::star::lang::WrappedTargetException );
  69
  70 };
  71
  72
  73 }; }; }; };
  74
  75 #endif
  76
  77 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */