1*cdf0e10cSrcweir/************************************************************************* 2*cdf0e10cSrcweir * 3*cdf0e10cSrcweir * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4*cdf0e10cSrcweir * 5*cdf0e10cSrcweir * Copyright 2000, 2010 Oracle and/or its affiliates. 6*cdf0e10cSrcweir * 7*cdf0e10cSrcweir * OpenOffice.org - a multi-platform office productivity suite 8*cdf0e10cSrcweir * 9*cdf0e10cSrcweir * This file is part of OpenOffice.org. 10*cdf0e10cSrcweir * 11*cdf0e10cSrcweir * OpenOffice.org is free software: you can redistribute it and/or modify 12*cdf0e10cSrcweir * it under the terms of the GNU Lesser General Public License version 3 13*cdf0e10cSrcweir * only, as published by the Free Software Foundation. 14*cdf0e10cSrcweir * 15*cdf0e10cSrcweir * OpenOffice.org is distributed in the hope that it will be useful, 16*cdf0e10cSrcweir * but WITHOUT ANY WARRANTY; without even the implied warranty of 17*cdf0e10cSrcweir * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18*cdf0e10cSrcweir * GNU Lesser General Public License version 3 for more details 19*cdf0e10cSrcweir * (a copy is included in the LICENSE file that accompanied this code). 20*cdf0e10cSrcweir * 21*cdf0e10cSrcweir * You should have received a copy of the GNU Lesser General Public License 22*cdf0e10cSrcweir * version 3 along with OpenOffice.org. If not, see 23*cdf0e10cSrcweir * <http://www.openoffice.org/license.html> 24*cdf0e10cSrcweir * for a copy of the LGPLv3 License. 25*cdf0e10cSrcweir * 26*cdf0e10cSrcweir ************************************************************************/ 27*cdf0e10cSrcweir#ifndef __com_sun_star_container_XHierarchicalNameAccess_idl__ 28*cdf0e10cSrcweir#define __com_sun_star_container_XHierarchicalNameAccess_idl__ 29*cdf0e10cSrcweir 30*cdf0e10cSrcweir#ifndef __com_sun_star_uno_XInterface_idl__ 31*cdf0e10cSrcweir#include <com/sun/star/uno/XInterface.idl> 32*cdf0e10cSrcweir#endif 33*cdf0e10cSrcweir 34*cdf0e10cSrcweir#ifndef __com_sun_star_container_NoSuchElementException_idl__ 35*cdf0e10cSrcweir#include <com/sun/star/container/NoSuchElementException.idl> 36*cdf0e10cSrcweir#endif 37*cdf0e10cSrcweir 38*cdf0e10cSrcweir//============================================================================= 39*cdf0e10cSrcweir 40*cdf0e10cSrcweirmodule com { module sun { module star { module container { 41*cdf0e10cSrcweir 42*cdf0e10cSrcweir//============================================================================= 43*cdf0e10cSrcweir 44*cdf0e10cSrcweir/** is used to have hierarchical access to elements within a container. 45*cdf0e10cSrcweir 46*cdf0e10cSrcweir <p>You address an object of a specific level in the hierarchy by giving its 47*cdf0e10cSrcweir fully qualified name, e.g., "com.sun.star.uno.XInterface". </p> 48*cdf0e10cSrcweir 49*cdf0e10cSrcweir <p>To implement inaccurate name access, support the 50*cdf0e10cSrcweir <type scope="com::sun::star::beans">XExactName</type> interface. </p> 51*cdf0e10cSrcweir 52*cdf0e10cSrcweir @see com::sun::star::beans::XExactName 53*cdf0e10cSrcweir */ 54*cdf0e10cSrcweirpublished interface XHierarchicalNameAccess: com::sun::star::uno::XInterface 55*cdf0e10cSrcweir{ 56*cdf0e10cSrcweir //------------------------------------------------------------------------- 57*cdf0e10cSrcweir 58*cdf0e10cSrcweir /** @returns 59*cdf0e10cSrcweir the object with the specified name. 60*cdf0e10cSrcweir 61*cdf0e10cSrcweir @param aName 62*cdf0e10cSrcweir the name of the object. 63*cdf0e10cSrcweir 64*cdf0e10cSrcweir @throws NoSuchElementException 65*cdf0e10cSrcweir if an element under Name does not exist. 66*cdf0e10cSrcweir */ 67*cdf0e10cSrcweir any getByHierarchicalName( [in] string aName ) 68*cdf0e10cSrcweir raises( com::sun::star::container::NoSuchElementException ); 69*cdf0e10cSrcweir 70*cdf0e10cSrcweir //------------------------------------------------------------------------- 71*cdf0e10cSrcweir 72*cdf0e10cSrcweir /** @returns 73*cdf0e10cSrcweir <TRUE/> if an element with this name is in 74*cdf0e10cSrcweir the container, <FALSE/> otherwise. 75*cdf0e10cSrcweir 76*cdf0e10cSrcweir <p>In many cases, the next call is <member>XNameAccess::getByName</member>. 77*cdf0e10cSrcweir You should optimize this case. 78*cdf0e10cSrcweir 79*cdf0e10cSrcweir @param aName 80*cdf0e10cSrcweir the name of the object. 81*cdf0e10cSrcweir */ 82*cdf0e10cSrcweir boolean hasByHierarchicalName( [in] string aName ); 83*cdf0e10cSrcweir 84*cdf0e10cSrcweir}; 85*cdf0e10cSrcweir 86*cdf0e10cSrcweir//============================================================================= 87*cdf0e10cSrcweir 88*cdf0e10cSrcweir}; }; }; }; 89*cdf0e10cSrcweir 90*cdf0e10cSrcweir#endif 91