udkapi/com/sun/star/beans/XHierarchicalPropertySetInfo.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: XHierarchicalPropertySetInfo.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_XHierarchicalPropertySetInfo_idl__
  31 #define __com_sun_star_beans_XHierarchicalPropertySetInfo_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_Property_idl__
  38 #include <com/sun/star/beans/Property.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_lang_IllegalArgumentException_idl__
  46 #include <com/sun/star/lang/IllegalArgumentException.idl>
  47 #endif
  48
  49
  50 //=============================================================================
  51
  52 module com {  module sun {  module star {  module beans {
  53
  54 //=============================================================================
  55
  56 /** specifies a hierarchy of properties.
  57
  58     <p>The specification only describes the properties, it does not contain
  59     any values.</p>
  60  */
  61 published interface XHierarchicalPropertySetInfo: com::sun::star::uno::XInterface
  62 {
  63     //-------------------------------------------------------------------------
  64
  65     /** @returns
  66                 the property with the specified name from the hierarchy.
  67
  68         @param aHierarchicalName
  69                 specifies the nested name of the property.
  70
  71         @throws UnknownPropertyException
  72                 if the property does not exist.
  73
  74         @throws com::sun::star::lang::IllegalArgumentException
  75                 if <var>aHierarchicalName</var> is not a well-formed
  76                 nested name for this hierarchy.
  77                    An implementation is not required to detect this
  78                 condition.
  79
  80      */
  81     com::sun::star::beans::Property getPropertyByHierarchicalName( [in] string aHierarchicalName )
  82             raises( com::sun::star::beans::UnknownPropertyException );
  83
  84     //-------------------------------------------------------------------------
  85
  86     /** @returns
  87                 <TRUE/> if a property with the specified name exists;
  88                 otherwise <FALSE/> is returned.
  89
  90         @param  aHierarchicalName
  91                 specifies the name of the property.
  92
  93         @throws com::sun::star::lang::IllegalArgumentException
  94                 if <var>aHierarchicalName</var> is not a well-formed
  95                 nested name for this hierarchy.
  96                    An implementation is not required to detect this
  97                 condition.
  98      */
  99     boolean hasPropertyByHierarchicalName( [in] string aHierarchicalName );
 100
 101 };
 102
 103 //=============================================================================
 104
 105 }; }; }; };
 106
 107 #endif