1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_beans_XHierarchicalPropertySetInfo_idl__
24#define __com_sun_star_beans_XHierarchicalPropertySetInfo_idl__
25
26#ifndef __com_sun_star_uno_XInterface_idl__
27#include <com/sun/star/uno/XInterface.idl>
28#endif
29
30#ifndef __com_sun_star_beans_Property_idl__
31#include <com/sun/star/beans/Property.idl>
32#endif
33
34#ifndef __com_sun_star_beans_UnknownPropertyException_idl__
35#include <com/sun/star/beans/UnknownPropertyException.idl>
36#endif
37
38#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
39#include <com/sun/star/lang/IllegalArgumentException.idl>
40#endif
41
42
43//=============================================================================
44
45module com {  module sun {  module star {  module beans {
46
47//=============================================================================
48
49/** specifies a hierarchy of properties.
50
51	<p>The specification only describes the properties, it does not contain
52	any values.</p>
53 */
54published interface XHierarchicalPropertySetInfo: com::sun::star::uno::XInterface
55{
56	//-------------------------------------------------------------------------
57
58	/** @returns
59				the property with the specified name from the hierarchy.
60
61		@param aHierarchicalName
62				specifies the nested name of the property.
63
64		@throws UnknownPropertyException
65				if the property does not exist.
66
67		@throws com::sun::star::lang::IllegalArgumentException
68				if <var>aHierarchicalName</var> is not a well-formed
69				nested name for this hierarchy.
70			   	An implementation is not required to detect this
71				condition.
72
73	 */
74	com::sun::star::beans::Property getPropertyByHierarchicalName( [in] string aHierarchicalName )
75			raises( com::sun::star::beans::UnknownPropertyException );
76
77	//-------------------------------------------------------------------------
78
79	/** @returns
80				<TRUE/> if a property with the specified name exists;
81				otherwise <FALSE/> is returned.
82
83		@param	aHierarchicalName
84				specifies the name of the property.
85
86		@throws com::sun::star::lang::IllegalArgumentException
87				if <var>aHierarchicalName</var> is not a well-formed
88				nested name for this hierarchy.
89			   	An implementation is not required to detect this
90				condition.
91	 */
92	boolean hasPropertyByHierarchicalName( [in] string aHierarchicalName );
93
94};
95
96//=============================================================================
97
98}; }; }; };
99
100#endif
101