xref: /aoo4110/main/udkapi/com/sun/star/beans/XPropertySetInfo.idl (revision b1cdbd2c)

/**************************************************************
 *
 * 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_XPropertySetInfo_idl__
#define __com_sun_star_beans_XPropertySetInfo_idl__

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

#ifndef __com_sun_star_beans_Property_idl__
#include <com/sun/star/beans/Property.idl>
#endif

#ifndef __com_sun_star_beans_UnknownPropertyException_idl__
#include <com/sun/star/beans/UnknownPropertyException.idl>
#endif


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

module com {  module sun {  module star {  module beans {

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

/** specifies a set of properties.

	<p>There are three kinds of properties:
	<ul>
		<li>bound properties</li>
		<li>constrained properties</li>
		<li>free properties</li>
	</ul>

	<p>The specification only describes the properties, it does not contain
	any values.</p>
 */
published interface XPropertySetInfo: com::sun::star::uno::XInterface
{
	//-------------------------------------------------------------------------

	/** @returns
			a sequence with all property descriptors which are specified
			within this <type>XPropertySetInfo</type>.
	 */
	sequence<com::sun::star::beans::Property> getProperties();

	//-------------------------------------------------------------------------

	/** @returns
			the property with the specified name from the object.

		@param aName
			specifies the name of the property.

		@throws UnknownPropertyException
			if the property does not exist.
	 */
	com::sun::star::beans::Property getPropertyByName( [in] string aName )
			raises( com::sun::star::beans::UnknownPropertyException );

	//-------------------------------------------------------------------------

	/** @returns
			<TRUE/> if a property with the specified name exist;
			otherwise <FALSE/> is returned.

		@param aName
			specifies the name of the property.
	 */
	boolean hasPropertyByName( [in] string Name );

};

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

}; }; }; };

#endif