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