xref: /aoo42x/main/udkapi/com/sun/star/container/XHierarchicalName.idl (revision 408a4873)

/**************************************************************
 *
 * 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
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the 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