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_XHierarchicalNameAccess_idl__
28#define __com_sun_star_container_XHierarchicalNameAccess_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_container_NoSuchElementException_idl__
35#include <com/sun/star/container/NoSuchElementException.idl>
36#endif
37
38//=============================================================================
39
40module com {  module sun {  module star {  module container {
41
42//=============================================================================
43
44/** is used to have hierarchical access to elements within a container.
45
46	<p>You address an object of a specific level in the hierarchy by giving its
47	fully qualified name, e.g., "com.sun.star.uno.XInterface". </p>
48
49	<p>To implement inaccurate name access, support the
50	<type scope="com::sun::star::beans">XExactName</type> interface.  </p>
51
52	@see com::sun::star::beans::XExactName
53 */
54published interface XHierarchicalNameAccess: com::sun::star::uno::XInterface
55{
56	//-------------------------------------------------------------------------
57
58	/** @returns
59				the object with the specified name.
60
61		@param aName
62			the name of the object.
63
64		@throws NoSuchElementException
65			if an element under Name does not exist.
66	 */
67	any getByHierarchicalName( [in] string aName )
68			raises( com::sun::star::container::NoSuchElementException );
69
70	//-------------------------------------------------------------------------
71
72	/** @returns
73			<TRUE/> if an element with this name is in
74			the container, <FALSE/> otherwise.
75
76		<p>In many cases, the next call is <member>XNameAccess::getByName</member>.
77		You should optimize this case.
78
79		@param aName
80			the name of the object.
81	 */
82	boolean hasByHierarchicalName( [in] string aName );
83
84};
85
86//=============================================================================
87
88}; }; }; };
89
90#endif
91