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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_container_XHierarchicalNameAccess_idl__
  20 #define __com_sun_star_container_XHierarchicalNameAccess_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23
  24 #include <com/sun/star/container/NoSuchElementException.idl>
  25
  26
  27 module com {  module sun {  module star {  module container {
  28
  29
  30 /** is used to have hierarchical access to elements within a container.
  31
  32     <p>You address an object of a specific level in the hierarchy by giving its
  33     fully qualified name, e.g., "com.sun.star.uno.XInterface". </p>
  34
  35     <p>To implement inaccurate name access, support the
  36     com::sun::star::beans::XExactName interface.  </p>
  37
  38     @see com::sun::star::beans::XExactName
  39  */
  40 published interface XHierarchicalNameAccess: com::sun::star::uno::XInterface
  41 {
  42
  43     /** @returns
  44                 the object with the specified name.
  45
  46         @param aName
  47             the name of the object.
  48
  49         @throws NoSuchElementException
  50             if an element under Name does not exist.
  51      */
  52     any getByHierarchicalName( [in] string aName )
  53             raises( com::sun::star::container::NoSuchElementException );
  54
  55
  56     /** @returns
  57             `TRUE` if an element with this name is in
  58             the container, `FALSE` otherwise.
  59
  60         <p>In many cases, the next call is XNameAccess::getByName().
  61         You should optimize this case.
  62
  63         @param aName
  64             the name of the object.
  65      */
  66     boolean hasByHierarchicalName( [in] string aName );
  67
  68 };
  69
  70
  71 }; }; }; };
  72
  73 #endif
  74
  75 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */