/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */
#ifndef __com_sun_star_container_XHierarchicalName_idl__
#define __com_sun_star_container_XHierarchicalName_idl__

#include <com/sun/star/uno/XInterface.idl>

#include <com/sun/star/lang/IllegalArgumentException.idl>

#include <com/sun/star/lang/NoSupportException.idl>


module com {  module sun {  module star {  module container {


/** specifies the fully qualified name of the object within a hierarchy.

    <p>The name is generally globally unique in the hierarchy.  </p>

    @see com::sun::star::container::XHierarchicalNameAccess
    @see com::sun::star::container::XNamed
 */
published interface XHierarchicalName: com::sun::star::uno::XInterface
{

    /** @returns
                the fully qualified hierarchical name of the object.
     */
    string getHierarchicalName();


    /** builds the hierarchical name of an object, given a relative name

        <p>Can be used to find the name of a descendant object in the hierarchy
        without actually accessing it.  </p>

        @see XHierarchicalNameAccess::hasByHierarchicalName
     */
    string composeHierarchicalName( [in] string aRelativeName )
            raises( com::sun::star::lang::IllegalArgumentException,
                    com::sun::star::lang::NoSupportException );
};


}; }; }; };

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
