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