xref: /trunk/main/udkapi/com/sun/star/beans/XFastPropertySet.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_beans_XFastPropertySet_idl__
#define __com_sun_star_beans_XFastPropertySet_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.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 a fast way of accessing and changing property values.

	<p>This interface is an extension to the <type>XPropertySet</type>
	interface. The get and set methods use handles to access the
	property values instead of character strings.</p>
 */
published interface XFastPropertySet: com::sun::star::uno::XInterface
{
	//-------------------------------------------------------------------------

	/** sets the value to the property with the specified name.

		@param nHandle
			contains the implementation handle of the
			implementation for the property.

		@param aValue
			contains the new value of the property.

		@throws UnknownPropertyException
			if the property does not exist.

		@throws PropertyVetoException
			if a vetoable listener does not approve the change of
			a property value.

		@throws IllegalArgumentException
			if the new value cannot be converted to the type of the
			underlying property by an identity or widening conversion.

		@throws  stardiv::uno::lang::WrappedTargetException
			if the implementation has an internal reason for the exception.
			In this case the original exception is wrapped into this
			<type scope="com::sun::star::lang">WrappedTargetException</type>.

	 */
	void setFastPropertyValue( [in] long nHandle,
			 [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 name PropertyName.

		@param nHandle
			contains the implementation handle of the implementation for the property.

		@throws UnknownPropertyException
			if the property does not exist.

		@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>.
	 */
	any getFastPropertyValue( [in] long nHandle )
			raises( com::sun::star::beans::UnknownPropertyException,
					com::sun::star::lang::WrappedTargetException );

};

//=============================================================================

}; }; }; };

#endif