xref: /AOO41X/main/udkapi/com/sun/star/beans/XHierarchicalPropertySetInfo.idl (revision 1ecadb572e7010ff3b3382ad9bf179dbc6efadbb)
1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_beans_XHierarchicalPropertySetInfo_idl__
28#define __com_sun_star_beans_XHierarchicalPropertySetInfo_idl__
29
30#ifndef __com_sun_star_uno_XInterface_idl__
31#include <com/sun/star/uno/XInterface.idl>
32#endif
33
34#ifndef __com_sun_star_beans_Property_idl__
35#include <com/sun/star/beans/Property.idl>
36#endif
37
38#ifndef __com_sun_star_beans_UnknownPropertyException_idl__
39#include <com/sun/star/beans/UnknownPropertyException.idl>
40#endif
41
42#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
43#include <com/sun/star/lang/IllegalArgumentException.idl>
44#endif
45
46
47//=============================================================================
48
49module com {  module sun {  module star {  module beans {
50
51//=============================================================================
52
53/** specifies a hierarchy of properties.
54
55	<p>The specification only describes the properties, it does not contain
56	any values.</p>
57 */
58published interface XHierarchicalPropertySetInfo: com::sun::star::uno::XInterface
59{
60	//-------------------------------------------------------------------------
61
62	/** @returns
63				the property with the specified name from the hierarchy.
64
65		@param aHierarchicalName
66				specifies the nested name of the property.
67
68		@throws UnknownPropertyException
69				if the property does not exist.
70
71		@throws com::sun::star::lang::IllegalArgumentException
72				if <var>aHierarchicalName</var> is not a well-formed
73				nested name for this hierarchy.
74			   	An implementation is not required to detect this
75				condition.
76
77	 */
78	com::sun::star::beans::Property getPropertyByHierarchicalName( [in] string aHierarchicalName )
79			raises( com::sun::star::beans::UnknownPropertyException );
80
81	//-------------------------------------------------------------------------
82
83	/** @returns
84				<TRUE/> if a property with the specified name exists;
85				otherwise <FALSE/> is returned.
86
87		@param	aHierarchicalName
88				specifies the name of the property.
89
90		@throws com::sun::star::lang::IllegalArgumentException
91				if <var>aHierarchicalName</var> is not a well-formed
92				nested name for this hierarchy.
93			   	An implementation is not required to detect this
94				condition.
95	 */
96	boolean hasPropertyByHierarchicalName( [in] string aHierarchicalName );
97
98};
99
100//=============================================================================
101
102}; }; }; };
103
104#endif
105