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