udkapi/com/sun/star/beans/XHierarchicalPropertySetInfo.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_XHierarchicalPropertySetInfo_idl__
  20 #define __com_sun_star_beans_XHierarchicalPropertySetInfo_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23
  24 #include <com/sun/star/beans/Property.idl>
  25
  26 #include <com/sun/star/beans/UnknownPropertyException.idl>
  27
  28 #include <com/sun/star/lang/IllegalArgumentException.idl>
  29
  30
  31
  32 module com {  module sun {  module star {  module beans {
  33
  34
  35 /** specifies a hierarchy of properties.
  36
  37     <p>The specification only describes the properties, it does not contain
  38     any values.</p>
  39  */
  40 published interface XHierarchicalPropertySetInfo: com::sun::star::uno::XInterface
  41 {
  42
  43     /** @returns
  44                 the property with the specified name from the hierarchy.
  45
  46         @param aHierarchicalName
  47                 specifies the nested name of the property.
  48
  49         @throws UnknownPropertyException
  50                 if the property does not exist.
  51
  52         @throws com::sun::star::lang::IllegalArgumentException
  53                 if <var>aHierarchicalName</var> is not a well-formed
  54                 nested name for this hierarchy.
  55                    An implementation is not required to detect this
  56                 condition.
  57
  58      */
  59     com::sun::star::beans::Property getPropertyByHierarchicalName( [in] string aHierarchicalName )
  60             raises( com::sun::star::beans::UnknownPropertyException );
  61
  62
  63     /** @returns
  64                 `TRUE` if a property with the specified name exists;
  65                 otherwise `FALSE` is returned.
  66
  67         @param  aHierarchicalName
  68                 specifies the name of the property.
  69
  70         @throws com::sun::star::lang::IllegalArgumentException
  71                 if <var>aHierarchicalName</var> is not a well-formed
  72                 nested name for this hierarchy.
  73                    An implementation is not required to detect this
  74                 condition.
  75      */
  76     boolean hasPropertyByHierarchicalName( [in] string aHierarchicalName );
  77
  78 };
  79
  80
  81 }; }; }; };
  82
  83 #endif
  84
  85 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */