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_container_XHierarchicalName_idl__
24#define __com_sun_star_container_XHierarchicalName_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_lang_IllegalArgumentException_idl__
31#include <com/sun/star/lang/IllegalArgumentException.idl>
32#endif
33
34#ifndef __com_sun_star_lang_NoSupportException_idl__
35#include <com/sun/star/lang/NoSupportException.idl>
36#endif
37
38//=============================================================================
39
40module com {  module sun {  module star {  module container {
41
42//=============================================================================
43
44/** specifies the fully qualified name of the object within a hierarchy.
45
46	<p>The name is generally globally unique in the hierarchy.  </p>
47
48	@see com::sun::star::container::XHierarchicalNameAccess
49	@see com::sun::star::container::XNamed
50 */
51published interface XHierarchicalName: com::sun::star::uno::XInterface
52{
53	//-------------------------------------------------------------------------
54
55	/** @returns
56				the fully qualified hierarchical name of the object.
57	 */
58	string getHierarchicalName();
59
60	//-------------------------------------------------------------------------
61
62	/** builds the hierarchical name of an object, given a relative name
63
64		<p>Can be used to find the name of a descendant object in the hierarchy
65		without actually accessing it.  </p>
66
67		@see XHierarchicalNameAccess::hasByHierarchicalName
68	 */
69	string composeHierarchicalName( [in] string aRelativeName )
70			raises( com::sun::star::lang::IllegalArgumentException,
71					com::sun::star::lang::NoSupportException );
72};
73
74//=============================================================================
75
76}; }; }; };
77
78#endif
79