udkapi/com/sun/star/container/XHierarchicalNameAccess.idl

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