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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XFastPropertySet.idl,v $
  10  * $Revision: 1.13 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_beans_XFastPropertySet_idl__
  31 #define __com_sun_star_beans_XFastPropertySet_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_beans_UnknownPropertyException_idl__
  38 #include <com/sun/star/beans/UnknownPropertyException.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_beans_PropertyVetoException_idl__
  42 #include <com/sun/star/beans/PropertyVetoException.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_lang_IllegalArgumentException_idl__
  46 #include <com/sun/star/lang/IllegalArgumentException.idl>
  47 #endif
  48
  49 #ifndef __com_sun_star_lang_WrappedTargetException_idl__
  50 #include <com/sun/star/lang/WrappedTargetException.idl>
  51 #endif
  52
  53
  54 //=============================================================================
  55
  56 module com {  module sun {  module star {  module beans {
  57
  58 //=============================================================================
  59
  60 /** provides a fast way of accessing and changing property values.
  61
  62     <p>This interface is an extension to the <type>XPropertySet</type>
  63     interface. The get and set methods use handles to access the
  64     property values instead of character strings.</p>
  65  */
  66 published interface XFastPropertySet: com::sun::star::uno::XInterface
  67 {
  68     //-------------------------------------------------------------------------
  69
  70     /** sets the value to the property with the specified name.
  71
  72         @param nHandle
  73             contains the implementation handle of the
  74             implementation for the property.
  75
  76         @param aValue
  77             contains the new value of the property.
  78
  79         @throws UnknownPropertyException
  80             if the property does not exist.
  81
  82         @throws PropertyVetoException
  83             if a vetoable listener does not approve the change of
  84             a property value.
  85
  86         @throws IllegalArgumentException
  87             if the new value cannot be converted to the type of the
  88             underlying property by an identity or widening conversion.
  89
  90         @throws  stardiv::uno::lang::WrappedTargetException
  91             if the implementation has an internal reason for the exception.
  92             In this case the original exception is wrapped into this
  93             <type scope="com::sun::star::lang">WrappedTargetException</type>.
  94
  95      */
  96     void setFastPropertyValue( [in] long nHandle,
  97              [in] any aValue )
  98             raises( com::sun::star::beans::UnknownPropertyException,
  99                     com::sun::star::beans::PropertyVetoException,
 100                     com::sun::star::lang::IllegalArgumentException,
 101                     com::sun::star::lang::WrappedTargetException );
 102
 103     //-------------------------------------------------------------------------
 104
 105     /** @returns
 106             the value of the property with the name PropertyName.
 107
 108         @param nHandle
 109             contains the implementation handle of the implementation for the property.
 110
 111         @throws UnknownPropertyException
 112             if the property does not exist.
 113
 114         @throws  com::sun::star::lang::WrappedTargetException
 115             if the implementation has an internal reason for the exception.
 116             In this case the original exception is wrapped into that
 117             <type scope="com::sun::star::lang">WrappedTargetException</type>.
 118      */
 119     any getFastPropertyValue( [in] long nHandle )
 120             raises( com::sun::star::beans::UnknownPropertyException,
 121                     com::sun::star::lang::WrappedTargetException );
 122
 123 };
 124
 125 //=============================================================================
 126
 127 }; }; }; };
 128
 129 #endif