/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 * 
 * Copyright 2008 by Sun Microsystems, Inc.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * $RCSfile: XHierarchicalName.idl,v $
 * $Revision: 1.10 $
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_container_XHierarchicalName_idl__ 
#define __com_sun_star_container_XHierarchicalName_idl__ 
 
#ifndef __com_sun_star_uno_XInterface_idl__ 
#include <com/sun/star/uno/XInterface.idl> 
#endif 
 
#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ 
#include <com/sun/star/lang/IllegalArgumentException.idl> 
#endif 
 
#ifndef __com_sun_star_lang_NoSupportException_idl__ 
#include <com/sun/star/lang/NoSupportException.idl> 
#endif 
 
//============================================================================= 
 
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 
