AOO410/main/udkapi/com/sun/star/beans/XHierarchicalPropertySet.idl

/**************************************************************
 * 
 * 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_beans_XHierarchicalPropertySet_idl__ 
#define __com_sun_star_beans_XHierarchicalPropertySet_idl__ 
 
#ifndef __com_sun_star_uno_XInterface_idl__ 
#include <com/sun/star/uno/XInterface.idl> 
#endif 
 
#ifndef __com_sun_star_beans_XHierarchicalPropertySetInfo_idl__ 
#include <com/sun/star/beans/XHierarchicalPropertySetInfo.idl> 
#endif 
 
#ifndef __com_sun_star_beans_UnknownPropertyException_idl__ 
#include <com/sun/star/beans/UnknownPropertyException.idl> 
#endif 
 
#ifndef __com_sun_star_beans_PropertyVetoException_idl__ 
#include <com/sun/star/beans/PropertyVetoException.idl> 
#endif 
 
#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ 
#include <com/sun/star/lang/IllegalArgumentException.idl> 
#endif 
 
#ifndef __com_sun_star_lang_WrappedTargetException_idl__ 
#include <com/sun/star/lang/WrappedTargetException.idl> 
#endif 
 
 
//============================================================================= 
 
module com {  module sun {  module star {  module beans {  
 
//============================================================================= 
 
/** provides information about and access to the
	a hierarchy of properties from an implementation. 
	
	<p> Usually an object that implements this interface
		also implements <type>XPropertySet</type> and at 
		least some of the properties have subproperties.  </p>

	<p> This interface allows direct access to subsubproperties, ...
		up to an arbitrary nesting depth. Often the intermediate 
		elements of the hierarchy implement <type>XProperty</type>.  </p>

	<p> Each implementation specifies how the 
		hierarchical property names, that are 
		used to access the elements of the hierarchy, 
		are formed.  </p>

	<p> Commonly a notation similar to filesystem pathes
		(separated by '/' slashes) or nested module names
		(separated by dots '.' or '::') is used.  </p>
	
 */
published interface XHierarchicalPropertySet: com::sun::star::uno::XInterface
{ 
	//------------------------------------------------------------------------- 
	 
	/** retrieve information about the hierarchy of properties

		@returns  
				the <type>XHierarchicalPropertySetInfo</type> interface, 
				which describes the property hierarchy of the object which 
				supplies this interface. 
				 
		@returns	 
				<NULL/> if the implementation cannot or will  
				not provide information about the properties; otherwise the  
				interface <type>XHierarchicalPropertySetInfo</type> is returned.
	 */
	com::sun::star::beans::XHierarchicalPropertySetInfo 
				getHierarchicalPropertySetInfo(); 
 
	//------------------------------------------------------------------------- 
	 
	/** sets the value of the property with the specified nested name.
		
		@param	aHierarchicalPropertyName	 
				This parameter specifies the name of the property. 
		 
		@param	aValue	 
				This parameter specifies the new value for the property. 
		 
		@throws UnknownPropertyException	 
				if the property does not exist. 
		 
		@throws PropertyVetoException  
				if the property is constrained and the change is vetoed by a 
				<type>XVetoableChangeListener</type>.
				
		@throws com::sun::star::uno::lang::IllegalArgumentException  
				if <var>aValue</var> is not a legal value for this property or 
				if <var>aHierarchicalPropertyName</var> is not a well-formed 
				nested name for this hierarchy.  
				An implementation is not required to detect the latter condition.

		@throws com::sun::star::lang::WrappedTargetException  
				if the implementation has an internal reason for the exception. 
				In this case the original exception is wrapped into that 
				<type scope="com::sun::star::lang">WrappedTargetException</type>.
				
		@see XPropertySet::setPropertyValue
	 */
	void setHierarchicalPropertyValue( [in] string aHierarchicalPropertyName, 
			 [in] any aValue ) 
			raises( com::sun::star::beans::UnknownPropertyException, 
					com::sun::star::beans::PropertyVetoException, 
					com::sun::star::lang::IllegalArgumentException, 
					com::sun::star::lang::WrappedTargetException ); 
 
	//------------------------------------------------------------------------- 
	 
	/** @returns 
				the value of the property with the specified nested name. 
				 
		@param	aHierarchicalPropertyName	 
				This parameter specifies the name of the property. 
		 
		@throws UnknownPropertyException	 
				if the property does not exist. 
		 
		@throws com::sun::star::uno::lang::IllegalArgumentException  
				if <var>aHierarchicalPropertyName</var> is not a well-formed 
				nested name for this hierarchy.
			   	An implementation is not required to detect this
				condition.

		@throws com::sun::star::lang::WrappedTargetException  
				if the implementation has an internal reason for the exception. 
				In this case the original exception is wrapped into that 
				<type scope="com::sun::star::lang">WrappedTargetException</type>.
				
		@see XPropertySet::getPropertyValue
	 */
	any getHierarchicalPropertyValue( [in] string aHierarchicalPropertyName ) 
			raises( com::sun::star::beans::UnknownPropertyException, 
					com::sun::star::lang::IllegalArgumentException, 
					com::sun::star::lang::WrappedTargetException ); 
 
	//------------------------------------------------------------------------- 
	 
}; 
 
//============================================================================= 
 
}; }; }; };  
 
#endif