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_util_XPropertyReplace_idl__
24#define __com_sun_star_util_XPropertyReplace_idl__
25
26#ifndef __com_sun_star_util_XReplaceDescriptor_idl__
27#include <com/sun/star/util/XReplaceDescriptor.idl>
28#endif
29
30#ifndef __com_sun_star_beans_PropertyValue_idl__
31#include <com/sun/star/beans/PropertyValue.idl>
32#endif
33
34#ifndef __com_sun_star_beans_UnknownPropertyException_idl__
35#include <com/sun/star/beans/UnknownPropertyException.idl>
36#endif
37
38#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
39#include <com/sun/star/lang/IllegalArgumentException.idl>
40#endif
41
42
43//=============================================================================
44
45module com {  module sun {  module star {  module util {
46
47//=============================================================================
48
49/** makes it possible to search and replace properties.
50 */
51published interface XPropertyReplace: com::sun::star::util::XReplaceDescriptor
52{
53	//-------------------------------------------------------------------------
54	/** provides the information if specific property values are
55		searched, or just the existence of the specified properties.
56	 */
57	boolean getValueSearch();
58
59	//-------------------------------------------------------------------------
60	/** specifies if specific property values are searched,
61		or just the existence of the specified properties.
62	 */
63	void setValueSearch( [in] boolean bValueSearch );
64
65	//-------------------------------------------------------------------------
66	/** @returns
67					the attributes to search for.
68	 */
69	sequence<com::sun::star::beans::PropertyValue> getSearchAttributes();
70
71	//-------------------------------------------------------------------------
72	/** sets the properties to search for.
73	 */
74	void setSearchAttributes( [in] sequence<com::sun::star::beans::PropertyValue> aSearchAttribs )
75			raises( com::sun::star::beans::UnknownPropertyException,
76					com::sun::star::lang::IllegalArgumentException );
77
78	//-------------------------------------------------------------------------
79	/** @returns
80					the attribute values which are used to replace the found occurrences.
81	 */
82	sequence<com::sun::star::beans::PropertyValue> getReplaceAttributes();
83
84	//-------------------------------------------------------------------------
85	/** sets the properties to replace the found occurrences.
86	 */
87	void setReplaceAttributes( [in] sequence<com::sun::star::beans::PropertyValue> aSearchAttribs )
88			raises( com::sun::star::beans::UnknownPropertyException,
89					com::sun::star::lang::IllegalArgumentException );
90
91};
92
93//=============================================================================
94
95}; }; }; };
96
97#endif
98