1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_beans_XPropertySetInfo_idl__
24#define __com_sun_star_beans_XPropertySetInfo_idl__
25
26#ifndef __com_sun_star_uno_XInterface_idl__
27#include <com/sun/star/uno/XInterface.idl>
28#endif
29
30#ifndef __com_sun_star_beans_Property_idl__
31#include <com/sun/star/beans/Property.idl>
32#endif
33
34#ifndef __com_sun_star_beans_UnknownPropertyException_idl__
35#include <com/sun/star/beans/UnknownPropertyException.idl>
36#endif
37
38
39//=============================================================================
40
41module com {  module sun {  module star {  module beans {
42
43//=============================================================================
44
45/** specifies a set of properties.
46
47	<p>There are three kinds of properties:
48	<ul>
49		<li>bound properties</li>
50		<li>constrained properties</li>
51		<li>free properties</li>
52	</ul>
53
54	<p>The specification only describes the properties, it does not contain
55	any values.</p>
56 */
57published interface XPropertySetInfo: com::sun::star::uno::XInterface
58{
59	//-------------------------------------------------------------------------
60
61	/** @returns
62			a sequence with all property descriptors which are specified
63			within this <type>XPropertySetInfo</type>.
64	 */
65	sequence<com::sun::star::beans::Property> getProperties();
66
67	//-------------------------------------------------------------------------
68
69	/** @returns
70			the property with the specified name from the object.
71
72		@param aName
73			specifies the name of the property.
74
75		@throws UnknownPropertyException
76			if the property does not exist.
77	 */
78	com::sun::star::beans::Property getPropertyByName( [in] string aName )
79			raises( com::sun::star::beans::UnknownPropertyException );
80
81	//-------------------------------------------------------------------------
82
83	/** @returns
84			<TRUE/> if a property with the specified name exist;
85			otherwise <FALSE/> is returned.
86
87		@param aName
88			specifies the name of the property.
89	 */
90	boolean hasPropertyByName( [in] string Name );
91
92};
93
94//=============================================================================
95
96}; }; }; };
97
98#endif
99