udkapi/com/sun/star/beans/XFastPropertySet.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
  20
  21
  22 module com {  module sun {  module star {  module beans {
  23
  24
  25 /** provides a fast way of accessing and changing property values.
  26
  27     <p>This interface is an extension to the XPropertySet
  28     interface. The get and set methods use handles to access the
  29     property values instead of character strings.</p>
  30  */
  31 published interface XFastPropertySet: com::sun::star::uno::XInterface
  32 {
  33
  34     /** sets the value to the property with the specified name.
  35
  36         @param nHandle
  37             contains the implementation handle of the
  38             implementation for the property.
  39
  40         @param aValue
  41             contains the new value of the property.
  42
  43         @throws UnknownPropertyException
  44             if the property does not exist.
  45
  46         @throws PropertyVetoException
  47             if a vetoable listener does not approve the change of
  48             a property value.
  49
  50         @throws IllegalArgumentException
  51             if the new value cannot be converted to the type of the
  52             underlying property by an identity or widening conversion.
  53
  54         @throws com::sun::star::lang::WrappedTargetException
  55             if the implementation has an internal reason for the exception.
  56             In this case the original exception is wrapped into this
  57             com::sun::star::lang::WrappedTargetException.
  58
  59      */
  60     void setFastPropertyValue( [in] long nHandle,
  61              [in] any aValue )
  62             raises( com::sun::star::beans::UnknownPropertyException,
  63                     com::sun::star::beans::PropertyVetoException,
  64                     com::sun::star::lang::IllegalArgumentException,
  65                     com::sun::star::lang::WrappedTargetException );
  66
  67
  68     /** @returns
  69             the value of the property with the name PropertyName.
  70
  71         @param nHandle
  72             contains the implementation handle of the implementation for the property.
  73
  74         @throws UnknownPropertyException
  75             if the property does not exist.
  76
  77         @throws  com::sun::star::lang::WrappedTargetException
  78             if the implementation has an internal reason for the exception.
  79             In this case the original exception is wrapped into that
  80             com::sun::star::lang::WrappedTargetException.
  81      */
  82     any getFastPropertyValue( [in] long nHandle )
  83             raises( com::sun::star::beans::UnknownPropertyException,
  84                     com::sun::star::lang::WrappedTargetException );
  85
  86 };
  87
  88
  89 }; }; }; };
  90
  91 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */