udkapi/com/sun/star/container/XHierarchicalName.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_XHierarchicalName_idl__
  20 #define __com_sun_star_container_XHierarchicalName_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23
  24 #include <com/sun/star/lang/IllegalArgumentException.idl>
  25
  26 #include <com/sun/star/lang/NoSupportException.idl>
  27
  28
  29 module com {  module sun {  module star {  module container {
  30
  31
  32 /** specifies the fully qualified name of the object within a hierarchy.
  33
  34     <p>The name is generally globally unique in the hierarchy.  </p>
  35
  36     @see com::sun::star::container::XHierarchicalNameAccess
  37     @see com::sun::star::container::XNamed
  38  */
  39 published interface XHierarchicalName: com::sun::star::uno::XInterface
  40 {
  41
  42     /** @returns
  43                 the fully qualified hierarchical name of the object.
  44      */
  45     string getHierarchicalName();
  46
  47
  48     /** builds the hierarchical name of an object, given a relative name
  49
  50         <p>Can be used to find the name of a descendant object in the hierarchy
  51         without actually accessing it.  </p>
  52
  53         @see XHierarchicalNameAccess::hasByHierarchicalName
  54      */
  55     string composeHierarchicalName( [in] string aRelativeName )
  56             raises( com::sun::star::lang::IllegalArgumentException,
  57                     com::sun::star::lang::NoSupportException );
  58 };
  59
  60
  61 }; }; }; };
  62
  63 #endif
  64
  65 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */