AOO410/main/offapi/com/sun/star/util/XPropertyReplace.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_util_XPropertyReplace_idl__ 
#define __com_sun_star_util_XPropertyReplace_idl__ 
 
#ifndef __com_sun_star_util_XReplaceDescriptor_idl__ 
#include <com/sun/star/util/XReplaceDescriptor.idl> 
#endif 
 
#ifndef __com_sun_star_beans_PropertyValue_idl__ 
#include <com/sun/star/beans/PropertyValue.idl> 
#endif 
 
#ifndef __com_sun_star_beans_UnknownPropertyException_idl__ 
#include <com/sun/star/beans/UnknownPropertyException.idl> 
#endif 
 
#ifndef __com_sun_star_lang_IllegalArgumentException_idl__ 
#include <com/sun/star/lang/IllegalArgumentException.idl> 
#endif 
 
 
//============================================================================= 
 
module com {  module sun {  module star {  module util {  
 
//============================================================================= 
 
/** makes it possible to search and replace properties.
 */
published interface XPropertyReplace: com::sun::star::util::XReplaceDescriptor
{ 
	//------------------------------------------------------------------------- 
	/** provides the information if specific property values are
		searched, or just the existence of the specified properties.
	 */
	boolean getValueSearch(); 
 
	//------------------------------------------------------------------------- 
	/** specifies if specific property values are searched,
		or just the existence of the specified properties.
	 */
	void setValueSearch( [in] boolean bValueSearch ); 
 
	//------------------------------------------------------------------------- 
	/** @returns 
					the attributes to search for.
	 */
	sequence<com::sun::star::beans::PropertyValue> getSearchAttributes(); 
 
	//------------------------------------------------------------------------- 
	/** sets the properties to search for.
	 */
	void setSearchAttributes( [in] sequence<com::sun::star::beans::PropertyValue> aSearchAttribs ) 
			raises( com::sun::star::beans::UnknownPropertyException, 
					com::sun::star::lang::IllegalArgumentException ); 
 
	//------------------------------------------------------------------------- 
	/** @returns 
					the attribute values which are used to replace the found occurrences.
	 */
	sequence<com::sun::star::beans::PropertyValue> getReplaceAttributes(); 
 
	//------------------------------------------------------------------------- 
	/** sets the properties to replace the found occurrences.
	 */
	void setReplaceAttributes( [in] sequence<com::sun::star::beans::PropertyValue> aSearchAttribs ) 
			raises( com::sun::star::beans::UnknownPropertyException, 
					com::sun::star::lang::IllegalArgumentException ); 
 
}; 
 
//============================================================================= 
 
}; }; }; };  
 
#endif