udkapi/com/sun/star/beans/XHierarchicalPropertySet.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: XHierarchicalPropertySet.idl,v $
  10  * $Revision: 1.14 $
  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_XHierarchicalPropertySet_idl__
  31 #define __com_sun_star_beans_XHierarchicalPropertySet_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_XHierarchicalPropertySetInfo_idl__
  38 #include <com/sun/star/beans/XHierarchicalPropertySetInfo.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_beans_UnknownPropertyException_idl__
  42 #include <com/sun/star/beans/UnknownPropertyException.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_beans_PropertyVetoException_idl__
  46 #include <com/sun/star/beans/PropertyVetoException.idl>
  47 #endif
  48
  49 #ifndef __com_sun_star_lang_IllegalArgumentException_idl__
  50 #include <com/sun/star/lang/IllegalArgumentException.idl>
  51 #endif
  52
  53 #ifndef __com_sun_star_lang_WrappedTargetException_idl__
  54 #include <com/sun/star/lang/WrappedTargetException.idl>
  55 #endif
  56
  57
  58 //=============================================================================
  59
  60 module com {  module sun {  module star {  module beans {
  61
  62 //=============================================================================
  63
  64 /** provides information about and access to the
  65     a hierarchy of properties from an implementation.
  66
  67     <p> Usually an object that implements this interface
  68         also implements <type>XPropertySet</type> and at
  69         least some of the properties have subproperties.  </p>
  70
  71     <p> This interface allows direct access to subsubproperties, ...
  72         up to an arbitrary nesting depth. Often the intermediate
  73         elements of the hierarchy implement <type>XProperty</type>.  </p>
  74
  75     <p> Each implementation specifies how the
  76         hierarchical property names, that are
  77         used to access the elements of the hierarchy,
  78         are formed.  </p>
  79
  80     <p> Commonly a notation similar to filesystem pathes
  81         (separated by '/' slashes) or nested module names
  82         (separated by dots '.' or '::') is used.  </p>
  83
  84  */
  85 published interface XHierarchicalPropertySet: com::sun::star::uno::XInterface
  86 {
  87     //-------------------------------------------------------------------------
  88
  89     /** retrieve information about the hierarchy of properties
  90
  91         @returns
  92                 the <type>XHierarchicalPropertySetInfo</type> interface,
  93                 which describes the property hierarchy of the object which
  94                 supplies this interface.
  95
  96         @returns
  97                 <NULL/> if the implementation cannot or will
  98                 not provide information about the properties; otherwise the
  99                 interface <type>XHierarchicalPropertySetInfo</type> is returned.
 100      */
 101     com::sun::star::beans::XHierarchicalPropertySetInfo
 102                 getHierarchicalPropertySetInfo();
 103
 104     //-------------------------------------------------------------------------
 105
 106     /** sets the value of the property with the specified nested name.
 107
 108         @param  aHierarchicalPropertyName
 109                 This parameter specifies the name of the property.
 110
 111         @param  aValue
 112                 This parameter specifies the new value for the property.
 113
 114         @throws UnknownPropertyException
 115                 if the property does not exist.
 116
 117         @throws PropertyVetoException
 118                 if the property is constrained and the change is vetoed by a
 119                 <type>XVetoableChangeListener</type>.
 120
 121         @throws com::sun::star::uno::lang::IllegalArgumentException
 122                 if <var>aValue</var> is not a legal value for this property or
 123                 if <var>aHierarchicalPropertyName</var> is not a well-formed
 124                 nested name for this hierarchy.
 125                 An implementation is not required to detect the latter condition.
 126
 127         @throws com::sun::star::lang::WrappedTargetException
 128                 if the implementation has an internal reason for the exception.
 129                 In this case the original exception is wrapped into that
 130                 <type scope="com::sun::star::lang">WrappedTargetException</type>.
 131
 132         @see XPropertySet::setPropertyValue
 133      */
 134     void setHierarchicalPropertyValue( [in] string aHierarchicalPropertyName,
 135              [in] any aValue )
 136             raises( com::sun::star::beans::UnknownPropertyException,
 137                     com::sun::star::beans::PropertyVetoException,
 138                     com::sun::star::lang::IllegalArgumentException,
 139                     com::sun::star::lang::WrappedTargetException );
 140
 141     //-------------------------------------------------------------------------
 142
 143     /** @returns
 144                 the value of the property with the specified nested name.
 145
 146         @param  aHierarchicalPropertyName
 147                 This parameter specifies the name of the property.
 148
 149         @throws UnknownPropertyException
 150                 if the property does not exist.
 151
 152         @throws com::sun::star::uno::lang::IllegalArgumentException
 153                 if <var>aHierarchicalPropertyName</var> is not a well-formed
 154                 nested name for this hierarchy.
 155                    An implementation is not required to detect this
 156                 condition.
 157
 158         @throws com::sun::star::lang::WrappedTargetException
 159                 if the implementation has an internal reason for the exception.
 160                 In this case the original exception is wrapped into that
 161                 <type scope="com::sun::star::lang">WrappedTargetException</type>.
 162
 163         @see XPropertySet::getPropertyValue
 164      */
 165     any getHierarchicalPropertyValue( [in] string aHierarchicalPropertyName )
 166             raises( com::sun::star::beans::UnknownPropertyException,
 167                     com::sun::star::lang::IllegalArgumentException,
 168                     com::sun::star::lang::WrappedTargetException );
 169
 170     //-------------------------------------------------------------------------
 171
 172 };
 173
 174 //=============================================================================
 175
 176 }; }; }; };
 177
 178 #endif