1*408a4873SAndrew Rist/************************************************************** 2cdf0e10cSrcweir * 3*408a4873SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4*408a4873SAndrew Rist * or more contributor license agreements. See the NOTICE file 5*408a4873SAndrew Rist * distributed with this work for additional information 6*408a4873SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7*408a4873SAndrew Rist * to you under the Apache License, Version 2.0 (the 8*408a4873SAndrew Rist * "License"); you may not use this file except in compliance 9*408a4873SAndrew Rist * with the License. You may obtain a copy of the License at 10*408a4873SAndrew Rist * 11*408a4873SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12*408a4873SAndrew Rist * 13*408a4873SAndrew Rist * Unless required by applicable law or agreed to in writing, 14*408a4873SAndrew Rist * software distributed under the License is distributed on an 15*408a4873SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*408a4873SAndrew Rist * KIND, either express or implied. See the License for the 17*408a4873SAndrew Rist * specific language governing permissions and limitations 18*408a4873SAndrew Rist * under the License. 19*408a4873SAndrew Rist * 20*408a4873SAndrew Rist *************************************************************/ 21*408a4873SAndrew Rist 22*408a4873SAndrew Rist 23cdf0e10cSrcweir#ifndef __com_sun_star_container_XHierarchicalNameAccess_idl__ 24cdf0e10cSrcweir#define __com_sun_star_container_XHierarchicalNameAccess_idl__ 25cdf0e10cSrcweir 26cdf0e10cSrcweir#ifndef __com_sun_star_uno_XInterface_idl__ 27cdf0e10cSrcweir#include <com/sun/star/uno/XInterface.idl> 28cdf0e10cSrcweir#endif 29cdf0e10cSrcweir 30cdf0e10cSrcweir#ifndef __com_sun_star_container_NoSuchElementException_idl__ 31cdf0e10cSrcweir#include <com/sun/star/container/NoSuchElementException.idl> 32cdf0e10cSrcweir#endif 33cdf0e10cSrcweir 34cdf0e10cSrcweir//============================================================================= 35cdf0e10cSrcweir 36cdf0e10cSrcweirmodule com { module sun { module star { module container { 37cdf0e10cSrcweir 38cdf0e10cSrcweir//============================================================================= 39cdf0e10cSrcweir 40cdf0e10cSrcweir/** is used to have hierarchical access to elements within a container. 41cdf0e10cSrcweir 42cdf0e10cSrcweir <p>You address an object of a specific level in the hierarchy by giving its 43cdf0e10cSrcweir fully qualified name, e.g., "com.sun.star.uno.XInterface". </p> 44cdf0e10cSrcweir 45cdf0e10cSrcweir <p>To implement inaccurate name access, support the 46cdf0e10cSrcweir <type scope="com::sun::star::beans">XExactName</type> interface. </p> 47cdf0e10cSrcweir 48cdf0e10cSrcweir @see com::sun::star::beans::XExactName 49cdf0e10cSrcweir */ 50cdf0e10cSrcweirpublished interface XHierarchicalNameAccess: com::sun::star::uno::XInterface 51cdf0e10cSrcweir{ 52cdf0e10cSrcweir //------------------------------------------------------------------------- 53cdf0e10cSrcweir 54cdf0e10cSrcweir /** @returns 55cdf0e10cSrcweir the object with the specified name. 56cdf0e10cSrcweir 57cdf0e10cSrcweir @param aName 58cdf0e10cSrcweir the name of the object. 59cdf0e10cSrcweir 60cdf0e10cSrcweir @throws NoSuchElementException 61cdf0e10cSrcweir if an element under Name does not exist. 62cdf0e10cSrcweir */ 63cdf0e10cSrcweir any getByHierarchicalName( [in] string aName ) 64cdf0e10cSrcweir raises( com::sun::star::container::NoSuchElementException ); 65cdf0e10cSrcweir 66cdf0e10cSrcweir //------------------------------------------------------------------------- 67cdf0e10cSrcweir 68cdf0e10cSrcweir /** @returns 69cdf0e10cSrcweir <TRUE/> if an element with this name is in 70cdf0e10cSrcweir the container, <FALSE/> otherwise. 71cdf0e10cSrcweir 72cdf0e10cSrcweir <p>In many cases, the next call is <member>XNameAccess::getByName</member>. 73cdf0e10cSrcweir You should optimize this case. 74cdf0e10cSrcweir 75cdf0e10cSrcweir @param aName 76cdf0e10cSrcweir the name of the object. 77cdf0e10cSrcweir */ 78cdf0e10cSrcweir boolean hasByHierarchicalName( [in] string aName ); 79cdf0e10cSrcweir 80cdf0e10cSrcweir}; 81cdf0e10cSrcweir 82cdf0e10cSrcweir//============================================================================= 83cdf0e10cSrcweir 84cdf0e10cSrcweir}; }; }; }; 85cdf0e10cSrcweir 86cdf0e10cSrcweir#endif 87